Point motion boundary condition to generate waves based on either piston or flap motions. More...
Public Types | |
enum | motionTypes { piston, flap, solitary } |
Public Types inherited from pointPatchField< vector > | |
typedef vector | value_type |
The Field value_type. More... | |
typedef DimensionedField< vector, pointMesh > | Internal |
The internal field type associated with the patch field. More... | |
typedef pointPatch | Patch |
The patch type for the patch field. More... | |
typedef calculatedPointPatchField< vector > | Calculated |
Type for a calculated patch. More... | |
Public Types inherited from Field< vector > | |
typedef pTraits< vector >::cmptType | cmptType |
Component type. More... | |
typedef SubField< vector > | subField |
Declare type of subField. More... | |
Public Types inherited from List< vector > | |
typedef SubList< vector > | subList |
Declare type of subList. More... | |
Public Types inherited from UList< T > | |
typedef T | value_type |
The value type the list contains. More... | |
typedef T * | pointer |
The pointer type for non-const access to value_type items. More... | |
typedef const T * | const_pointer |
The pointer type for const access to value_type items. More... | |
typedef T & | reference |
The type used for storing into value_type objects. More... | |
typedef const T & | const_reference |
The type used for reading from constant value_type objects. More... | |
typedef T * | iterator |
Random access iterator for traversing a UList. More... | |
typedef const T * | const_iterator |
Random access iterator for traversing a UList. More... | |
typedef label | size_type |
The type to represent the size of a UList. More... | |
typedef label | difference_type |
The difference between iterator objects. More... | |
typedef std::reverse_iterator< iterator > | reverse_iterator |
Reverse iterator (non-const access) More... | |
typedef std::reverse_iterator< const_iterator > | const_reverse_iterator |
Reverse iterator (const access) More... | |
Public Member Functions | |
const vector & | g () |
Return the gravitational acceleration. More... | |
virtual scalar | waveLength (const scalar h, const scalar T) |
Dispersion equation. More... | |
virtual scalar | timeCoeff (const scalar t) const |
Return the time scaling coefficient. More... | |
virtual void | initialiseGeometry () |
Initialise. More... | |
TypeName ("waveMaker") | |
Runtime type information. More... | |
waveMakerPointPatchVectorField (const pointPatch &, const DimensionedField< vector, pointMesh > &) | |
Construct from patch and internal field. More... | |
waveMakerPointPatchVectorField (const pointPatch &, const DimensionedField< vector, pointMesh > &, const dictionary &) | |
Construct from patch, internal field and dictionary. More... | |
waveMakerPointPatchVectorField (const waveMakerPointPatchVectorField &, const pointPatch &, const DimensionedField< vector, pointMesh > &, const pointPatchFieldMapper &) | |
Construct by mapping given patchField<vector> onto a new patch. More... | |
virtual autoPtr< pointPatchField< vector > > | clone () const |
Construct and return a clone. More... | |
waveMakerPointPatchVectorField (const waveMakerPointPatchVectorField &, const DimensionedField< vector, pointMesh > &) | |
Construct as copy setting internal field reference. More... | |
virtual autoPtr< pointPatchField< vector > > | clone (const DimensionedField< vector, pointMesh > &iF) const |
Construct and return a clone setting internal field reference. More... | |
virtual void | updateCoeffs () |
Update the coefficients associated with the patch field. More... | |
virtual void | write (Ostream &) const |
Write. More... | |
Public Member Functions inherited from fixedValuePointPatchField< vector > | |
TypeName ("fixedValue") | |
Runtime type information. More... | |
fixedValuePointPatchField (const pointPatch &, const DimensionedField< vector, pointMesh > &) | |
Construct from patch and internal field. More... | |
fixedValuePointPatchField (const pointPatch &, const DimensionedField< vector, pointMesh > &, const dictionary &, const bool valueRequired=true) | |
Construct from patch, internal field and dictionary. More... | |
fixedValuePointPatchField (const fixedValuePointPatchField< vector > &, const pointPatch &, const DimensionedField< vector, pointMesh > &, const pointPatchFieldMapper &) | |
Construct by mapping given patchField<Type> onto a new patch. More... | |
fixedValuePointPatchField (const fixedValuePointPatchField< vector > &, const DimensionedField< vector, pointMesh > &) | |
Construct as copy setting internal field reference. More... | |
virtual bool | fixesValue () const |
Return true if this patch field fixes a value. More... | |
virtual void | operator= (const Field< vector > &) |
virtual void | operator= (const vector &) |
Public Member Functions inherited from valuePointPatchField< vector > | |
TypeName ("value") | |
Declare type-name, virtual type (with debug switch) More... | |
valuePointPatchField (const valuePointPatchField &)=default | |
Copy construct. More... | |
valuePointPatchField (const pointPatch &, const DimensionedField< vector, pointMesh > &) | |
Construct from patch and internal field. More... | |
valuePointPatchField (const pointPatch &, const DimensionedField< vector, pointMesh > &, const dictionary &, const bool valueRequired=true) | |
Construct from patch, internal field and dictionary. More... | |
valuePointPatchField (const valuePointPatchField< vector > &, const pointPatch &, const DimensionedField< vector, pointMesh > &, const pointPatchFieldMapper &) | |
Construct by mapping given patchField<Type> onto a new patch. More... | |
valuePointPatchField (const valuePointPatchField< vector > &, const DimensionedField< vector, pointMesh > &) | |
Construct as copy setting internal field reference. More... | |
label | size () const |
Return size. More... | |
virtual void | autoMap (const pointPatchFieldMapper &) |
Map (and resize as needed) from self given a mapping object. More... | |
virtual void | rmap (const pointPatchField< vector > &, const labelList &) |
Reverse map the given PointPatchField onto. More... | |
virtual void | evaluate (const Pstream::commsTypes commsType=Pstream::commsTypes::blocking) |
Evaluate the patch field. More... | |
virtual void | operator= (const valuePointPatchField< vector > &) |
virtual void | operator= (const pointPatchField< vector > &) |
virtual void | operator== (const valuePointPatchField< vector > &) |
virtual void | operator== (const pointPatchField< vector > &) |
virtual void | operator== (const Field< vector > &) |
virtual void | operator== (const vector &) |
Public Member Functions inherited from pointPatchField< vector > | |
declareRunTimeSelectionTable (autoPtr, pointPatchField, patch,(const pointPatch &p, const DimensionedField< vector, pointMesh > &iF),(p, iF)) | |
declareRunTimeSelectionTable (autoPtr, pointPatchField, patchMapper,(const pointPatchField< vector > &ptf, const pointPatch &p, const DimensionedField< vector, pointMesh > &iF, const pointPatchFieldMapper &m),(dynamic_cast< const pointPatchFieldType & >(ptf), p, iF, m)) | |
declareRunTimeSelectionTable (autoPtr, pointPatchField, dictionary,(const pointPatch &p, const DimensionedField< vector, pointMesh > &iF, const dictionary &dict),(p, iF, dict)) | |
pointPatchField (const pointPatch &, const DimensionedField< vector, pointMesh > &) | |
Construct from patch and internal field. More... | |
pointPatchField (const pointPatch &, const DimensionedField< vector, pointMesh > &, const dictionary &) | |
Construct from patch, internal field and dictionary. More... | |
pointPatchField (const pointPatchField< vector > &, const pointPatch &, const DimensionedField< vector, pointMesh > &, const pointPatchFieldMapper &) | |
Construct by mapping given patchField<Type> onto a new patch. More... | |
pointPatchField (const pointPatchField< vector > &) | |
Construct as copy. More... | |
pointPatchField (const pointPatchField< vector > &, const DimensionedField< vector, pointMesh > &) | |
Construct as copy setting internal field reference. More... | |
Foam::autoPtr< Foam::pointPatchField< vector > > | NewCalculatedType (const pointPatchField< Type2 > &pf) |
virtual | ~pointPatchField ()=default |
Destructor. More... | |
virtual bool | coupled () const |
True if this patch field is coupled. More... | |
virtual const word & | constraintType () const |
The constraint type this pointPatchField implements. More... | |
label | size () const |
Return the patch size. More... | |
const DimensionedField< vector, pointMesh > & | internalField () const noexcept |
Return dimensioned internal field reference. More... | |
const Field< vector > & | primitiveField () const noexcept |
Return internal field reference. More... | |
tmp< Field< vector > > | patchInternalField () const |
Return field created from appropriate internal field values. More... | |
tmp< Field< Type1 > > | patchInternalField (const Field< Type1 > &iF) const |
Return field created from appropriate internal field values. More... | |
tmp< Field< Type1 > > | patchInternalField (const Field< Type1 > &iF, const labelList &meshPoints) const |
Return field created from selected internal field values. More... | |
Foam::tmp< Foam::Field< Type1 > > | patchInternalField (const Field< Type1 > &iF, const labelList &meshPoints) const |
Foam::tmp< Foam::Field< Type1 > > | patchInternalField (const Field< Type1 > &iF) const |
void | addToInternalField (Field< Type1 > &iF, const Field< Type1 > &pF) const |
Given the internal field and a patch field,. More... | |
void | addToInternalField (Field< Type1 > &iF, const Field< Type1 > &pF, const labelList &points) const |
Given the internal field and a patch field,. More... | |
void | setInInternalField (Field< Type1 > &iF, const Field< Type1 > &pF, const labelList &meshPoints) const |
Given the internal field and a patch field,. More... | |
void | setInInternalField (Field< Type1 > &iF, const Field< Type1 > &pF) const |
Given the internal field and a patch field,. More... | |
virtual void | initEvaluate (const Pstream::commsTypes commsType=Pstream::commsTypes::blocking) |
Initialise evaluation of the patch field (do nothing) More... | |
virtual void | operator+= (const pointPatchField< vector > &) |
virtual void | operator+= (const Field< vector > &) |
virtual void | operator+= (const vector &) |
virtual void | operator-= (const pointPatchField< vector > &) |
virtual void | operator-= (const Field< vector > &) |
virtual void | operator-= (const vector &) |
virtual void | operator*= (const pointPatchField< scalar > &) |
virtual void | operator*= (const Field< scalar > &) |
virtual void | operator*= (const scalar) |
virtual void | operator/= (const pointPatchField< scalar > &) |
virtual void | operator/= (const Field< scalar > &) |
virtual void | operator/= (const scalar) |
void | negate () |
Negate the field inplace. Dummy placeholder for FieldField. More... | |
void | normalise () |
Normalise the field inplace. Dummy placeholder for FieldField. More... | |
Public Member Functions inherited from pointPatchFieldBase | |
TypeName ("pointPatchField") | |
Runtime type information. More... | |
pointPatchFieldBase (const pointPatch &p) | |
Construct from patch. More... | |
pointPatchFieldBase (const pointPatch &p, const word &patchType) | |
Construct from patch and patch type. More... | |
pointPatchFieldBase (const pointPatch &p, const dictionary &dict) | |
Construct from patch and dictionary. More... | |
pointPatchFieldBase (const pointPatchFieldBase &, const pointPatch &p) | |
Copy construct with new patch. More... | |
pointPatchFieldBase (const pointPatchFieldBase &) | |
Copy construct. More... | |
virtual | ~pointPatchFieldBase ()=default |
Destructor. More... | |
const objectRegistry & | db () const |
The associated objectRegistry. More... | |
const pointPatch & | patch () const noexcept |
Return the patch. More... | |
const word & | patchType () const noexcept |
The optional patch type. More... | |
word & | patchType () noexcept |
The optional patch type. More... | |
bool | updated () const noexcept |
True if the boundary condition has already been updated. More... | |
void | checkPatch (const pointPatchFieldBase &rhs) const |
Check that patches are identical. More... | |
Public Member Functions inherited from Field< vector > | |
constexpr | Field () noexcept |
Default construct. More... | |
Field (const label len) | |
Construct given size. More... | |
Field (const label len, const vector &val) | |
Construct given size and initial value. More... | |
Field (const label len, const Foam::zero) | |
Construct given size and initial values of zero. More... | |
Field (const Foam::one, const vector &val) | |
Construct with length=1, copying the value as the only content. More... | |
Field (const Foam::one, vector &&val) | |
Construct with length=1, moving the value as the only content. More... | |
Field (const Foam::one, const Foam::zero) | |
Construct with length=1, initializing content to zero. More... | |
Field (const Field< vector > &fld) | |
Copy construct. More... | |
Field (const UList< vector > &list) | |
Copy construct from UList<Type> More... | |
Field (const IndirectListBase< vector, Addr > &list) | |
Copy construct from IndirectList. More... | |
Field (Field< vector > &&fld) | |
Move construct from Field. More... | |
Field (List< vector > &&list) | |
Move construct from List. More... | |
Field (DynamicList< vector, SizeMin > &&list) | |
Move construct from DynamicList. More... | |
Field (const UList< vector > &mapF, const labelUList &mapAddressing) | |
Construct by 1 to 1 mapping from the given field. More... | |
Field (const tmp< Field< vector >> &tmapF, const labelUList &mapAddressing) | |
Construct by 1 to 1 mapping from the given tmp field. More... | |
Field (const UList< vector > &mapF, const labelListList &mapAddressing, const scalarListList &weights) | |
Construct by interpolative mapping from the given field. More... | |
Field (const tmp< Field< vector >> &tmapF, const labelListList &mapAddressing, const scalarListList &weights) | |
Construct by interpolative mapping from the given tmp field. More... | |
Field (const UList< vector > &mapF, const FieldMapper &map, const bool applyFlip=true) | |
Construct by mapping from the given field. More... | |
Field (const UList< vector > &mapF, const FieldMapper &map, const vector &defaultValue, const bool applyFlip=true) | |
Construct by mapping from the given field. More... | |
Field (const UList< vector > &mapF, const FieldMapper &map, const UList< vector > &defaultValues, const bool applyFlip=true) | |
Construct by mapping from the given field. More... | |
Field (const tmp< Field< vector >> &tmapF, const FieldMapper &map, const bool applyFlip=true) | |
Construct by mapping from the given tmp field. More... | |
Field (const tmp< Field< vector >> &tmapF, const FieldMapper &map, const vector &defaultValue, const bool applyFlip=true) | |
Construct by mapping from the given tmp field. Uses supplied uniform value for unmapped items. More... | |
Field (const tmp< Field< vector >> &tmapF, const FieldMapper &map, const UList< vector > &defaultValues, const bool applyFlip=true) | |
Construct by mapping from the given tmp field. Uses supplied values for unmapped items. More... | |
Field (Field< vector > &fld, bool reuse) | |
Copy construct or re-use as specified. More... | |
Field (const tmp< Field< vector >> &tfld) | |
Copy or move construct from tmp. More... | |
Field (Istream &is) | |
Construct from Istream. More... | |
Field (const entry &e, const label len) | |
Construct from a dictionary (primitive) entry. More... | |
Field (const word &keyword, const dictionary &dict, const label len, enum keyType::option matchOpt=keyType::REGEX) | |
Construct from lookup of a dictionary (primitive) entry. More... | |
tmp< Field< vector > > | clone () const |
Clone. More... | |
void | assign (const entry &e, const label len) |
Assign from a dictionary (primitive) entry. More... | |
void | assign (const word &keyword, const dictionary &dict, const label len, enum keyType::option matchOpt=keyType::REGEX) |
Assign from lookup of a dictionary (primitive) entry. More... | |
void | map (const UList< vector > &mapF, const labelUList &mapAddressing) |
1 to 1 map from the given field More... | |
void | map (const tmp< Field< vector >> &tmapF, const labelUList &mapAddressing) |
1 to 1 map from the given tmp field More... | |
void | map (const UList< vector > &mapF, const labelListList &mapAddressing, const scalarListList &weights) |
Interpolative map from the given field. More... | |
void | map (const tmp< Field< vector >> &tmapF, const labelListList &mapAddressing, const scalarListList &weights) |
Interpolative map from the given tmp field. More... | |
void | map (const UList< vector > &mapF, const FieldMapper &map, const bool applyFlip=true) |
Map from the given field. More... | |
void | map (const tmp< Field< vector >> &tmapF, const FieldMapper &map, const bool applyFlip=true) |
Map from the given tmp field. More... | |
void | autoMap (const FieldMapper &map, const bool applyFlip=true) |
Map from self. More... | |
void | rmap (const UList< vector > &mapF, const labelUList &mapAddressing) |
1 to 1 reverse-map from the given field More... | |
void | rmap (const tmp< Field< vector >> &tmapF, const labelUList &mapAddressing) |
1 to 1 reverse-map from the given tmp field More... | |
void | rmap (const UList< vector > &mapF, const labelUList &mapAddressing, const UList< scalar > &weights) |
Interpolative reverse map from the given field. More... | |
void | rmap (const tmp< Field< vector >> &tmapF, const labelUList &mapAddressing, const UList< scalar > &weights) |
Interpolative reverse map from the given tmp field. More... | |
void | negate () |
Inplace negate this field (negative). More... | |
void | normalise () |
Inplace normalise this field. Generally a no-op except for vector fields. More... | |
void | normalise () |
void | normalise () |
void | normalise () |
Inplace normalise (float) vector field. More... | |
void | normalise () |
Inplace normalise (double) vector field. More... | |
tmp< Field< cmptType > > | component (const direction) const |
Return a component field of the field. More... | |
void | replace (const direction, const UList< cmptType > &) |
Replace a component field of the field. More... | |
void | replace (const direction, const tmp< Field< cmptType >> &) |
Replace a component field of the field. More... | |
void | replace (const direction, const cmptType &) |
Replace a component field of the field. More... | |
VSForm | block (const label start) const |
tmp< Field< vector > > | T () const |
Return the field transpose (only defined for second rank tensors) More... | |
void | writeEntry (const word &keyword, Ostream &os) const |
Write the field as a dictionary entry. More... | |
SubField< vector > | slice (const label pos, label len=-1) |
Return SubField slice (non-const access) - no range checking. More... | |
const SubField< vector > | slice (const label pos, label len=-1) const |
Return SubField slice (const access) - no range checking. More... | |
SubField< vector > | slice (const labelRange &range) |
Return SubField slice (non-const access) - with range checking. More... | |
const SubField< vector > | slice (const labelRange &range) const |
Return SubField slice (const access) - with range checking. More... | |
void | operator= (const Field< vector > &) |
Copy assignment. More... | |
void | operator= (const tmp< Field< vector >> &) |
void | operator= (const UList< vector > &rhs) |
void | operator= (const SubField< vector > &rhs) |
void | operator= (const IndirectListBase< vector, Addr > &rhs) |
Copy assign from IndirectList. More... | |
void | operator= (Field< vector > &&rhs) |
Move assignment. More... | |
void | operator= (List< vector > &&rhs) |
void | operator= (DynamicList< vector, SizeMin > &&rhs) |
void | operator= (const vector &val) |
Value assignment. More... | |
void | operator= (const Foam::zero) |
void | operator= (const VectorSpace< Form, Cmpt, nCmpt > &) |
void | operator= (const tmp< Field > &rhs) |
void | operator+= (const UList< vector > &) |
void | operator+= (const tmp< Field< vector >> &) |
void | operator+= (const vector &) |
void | operator-= (const UList< vector > &) |
void | operator-= (const tmp< Field< vector >> &) |
void | operator-= (const vector &) |
void | operator*= (const UList< scalar > &) |
void | operator*= (const tmp< Field< scalar >> &) |
void | operator*= (const scalar &) |
void | operator/= (const UList< scalar > &) |
void | operator/= (const tmp< Field< scalar >> &) |
void | operator/= (const scalar &) |
Public Member Functions inherited from FieldBase | |
constexpr | FieldBase () noexcept |
Default construct. More... | |
Public Member Functions inherited from refCount | |
constexpr | refCount () noexcept |
Default construct, initializing count to 0. More... | |
int | count () const noexcept |
Return the current reference count. More... | |
bool | unique () const noexcept |
Return true if the reference count is zero. More... | |
void | operator++ () noexcept |
Increment the reference count. More... | |
void | operator++ (int) noexcept |
Increment the reference count. More... | |
void | operator-- () noexcept |
Decrement the reference count. More... | |
void | operator-- (int) noexcept |
Decrement the reference count. More... | |
Public Member Functions inherited from List< vector > | |
constexpr | List () noexcept |
Default construct. More... | |
List (const label len) | |
Construct with given size. More... | |
List (const label len, const vector &val) | |
Construct with given size and value for all elements. More... | |
List (const label len, const Foam::zero) | |
Construct with given size initializing all elements to zero. More... | |
List (const Foam::one, const vector &val) | |
Construct with length=1, copying the value as the only content. More... | |
List (const Foam::one, vector &&val) | |
Construct with length=1, moving the value as the only content. More... | |
List (const Foam::one, const Foam::zero) | |
Construct with length=1, initializing content to zero. More... | |
List (const List< vector > &a) | |
Copy construct from list. More... | |
List (const UList< vector > &a) | |
Copy construct contents from list. More... | |
List (List< vector > &a, bool reuse) | |
Construct as copy or re-use as specified. More... | |
List (const UList< vector > &list, const labelUList &indices) | |
Copy construct subset of list. More... | |
List (const UList< vector > &list, const FixedList< label, N > &indices) | |
Copy construct subset of list. More... | |
List (const FixedList< vector, N > &list) | |
Construct as copy of FixedList<T, N> More... | |
List (const PtrList< vector > &list) | |
Construct as copy of PtrList<T> More... | |
List (const SLList< vector > &list) | |
Construct as copy of SLList<T> More... | |
List (const IndirectListBase< vector, Addr > &list) | |
Construct as copy of IndirectList contents. More... | |
List (std::initializer_list< vector > list) | |
Construct from an initializer list. More... | |
List (List< vector > &&list) | |
Move construct from List. More... | |
List (DynamicList< vector, SizeMin > &&list) | |
Move construct from DynamicList. More... | |
List (SLList< vector > &&list) | |
Move construct from SLList. More... | |
List (Istream &is) | |
Construct from Istream. More... | |
autoPtr< List< vector > > | clone () const |
Clone. More... | |
~List () | |
Destructor. More... | |
void | clear () |
Clear the list, i.e. set size to zero. More... | |
void | resize (const label len) |
Adjust allocated size of list. More... | |
void | resize (const label len, const vector &val) |
Adjust allocated size of list and set val for new elements. More... | |
void | resize (const label newLen) |
void | resize_nocopy (const label len) |
Adjust allocated size of list without necessarily. More... | |
void | setSize (const label n) |
Alias for resize() More... | |
void | setSize (const label n, const vector &val) |
Alias for resize() More... | |
void | transfer (List< vector > &list) |
Transfer the contents of the argument List into this list and annul the argument list. More... | |
void | transfer (DynamicList< vector, SizeMin > &list) |
Transfer the contents of the argument List into this list and annul the argument list. More... | |
vector & | newElmt (const label i) |
Return subscript-checked element of UList and resizing the list if required. More... | |
void | push_back (const vector &val) |
Append an element at the end of the list. More... | |
void | push_back (vector &&val) |
Move append an element at the end of the list. More... | |
void | push_back (const UList< vector > &list) |
Append a List to the end of this list. More... | |
void | push_back (const IndirectListBase< vector, Addr > &list) |
Append IndirectList contents at the end of this list. More... | |
label | push_uniq (const vector &val) |
Append an element if not already in the list. More... | |
void | pop_back (label n=1) |
Reduce size by 1 or more elements. Can be called on an empty list. More... | |
void | operator= (const UList< vector > &a) |
Assignment to UList operator. Takes linear time. More... | |
void | operator= (const List< vector > &list) |
Assignment operator. Takes linear time. More... | |
void | operator= (const SLList< vector > &list) |
Assignment to SLList operator. Takes linear time. More... | |
void | operator= (const IndirectListBase< vector, Addr > &list) |
Assignment from IndirectList. Takes linear time. More... | |
void | operator= (const FixedList< vector, N > &list) |
Copy assignment from FixedList. More... | |
void | operator= (std::initializer_list< vector > list) |
Assignment to an initializer list. More... | |
void | operator= (const vector &val) |
Assignment of all entries to the given value. More... | |
void | operator= (const Foam::zero) |
Assignment of all entries to zero. More... | |
void | operator= (List< vector > &&list) |
Move assignment. Takes constant time. More... | |
void | operator= (DynamicList< vector, SizeMin > &&list) |
Move assignment. Takes constant time. More... | |
void | operator= (SLList< vector > &&list) |
Move assignment. Takes constant time. More... | |
Istream & | readList (Istream &is) |
Read List from Istream, discarding contents of existing List. More... | |
Istream & | readList (Istream &is) |
Specialized list reading for character lists which always uses binary format. More... | |
Istream & | readList (Istream &is) |
void | shallowCopy (const UList< vector > &)=delete |
No shallowCopy permitted. More... | |
std::enable_if< std::is_same< bool, TypeT >::value, bool >::type | set (const label i, bool val=true) |
A bitSet::set() method for a list of bool. More... | |
void | append (const vector &val) |
Append an element at the end of the list. More... | |
void | append (vector &&val) |
Move append an element at the end of the list. More... | |
void | append (const UList< vector > &list) |
Append a List to the end of this list. More... | |
void | append (const IndirectListBase< vector, Addr > &list) |
Append IndirectList contents at the end of this list. More... | |
label | appendUniq (const vector &val) |
Append an element if not already in the list. More... | |
Public Member Functions inherited from UList< T > | |
UList (const UList< T > &)=default | |
Copy construct. More... | |
constexpr | UList () noexcept |
Default construct, zero-sized and nullptr. More... | |
UList (T *__restrict__ v, const label len) noexcept | |
Construct from components. More... | |
label | fcIndex (const label i) const noexcept |
The forward circular index. The next index in the list which returns to the first at the end of the list. More... | |
label | rcIndex (const label i) const noexcept |
The reverse circular index. The previous index in the list which returns to the last at the beginning of the list. More... | |
const T & | fcValue (const label i) const |
Return forward circular value (ie, next value in the list) More... | |
T & | fcValue (const label i) |
Return forward circular value (ie, next value in the list) More... | |
const T & | rcValue (const label i) const |
Return reverse circular value (ie, previous value in the list) More... | |
T & | rcValue (const label i) |
Return reverse circular value (ie, previous value in the list) More... | |
const T * | cdata () const noexcept |
Return pointer to the underlying array serving as data storage. More... | |
T * | data () noexcept |
Return pointer to the underlying array serving as data storage. More... | |
const char * | cdata_bytes () const noexcept |
Return pointer to the underlying array serving as data storage,. More... | |
char * | data_bytes () noexcept |
Return pointer to the underlying array serving as data storage,. More... | |
T & | front () |
Access first element of the list, position [0]. More... | |
const T & | front () const |
Access first element of the list. More... | |
T & | back () |
Access last element of the list, position [size()-1]. More... | |
const T & | back () const |
Access last element of the list, position [size()-1]. More... | |
std::streamsize | size_bytes () const noexcept |
Number of contiguous bytes for the List data. More... | |
std::streamsize | byteSize () const |
Number of contiguous bytes for the List data, runtime FatalError if type is not contiguous. More... | |
void | checkStart (const label start) const |
Check start is within valid range [0,size) More... | |
void | checkSize (const label size) const |
Check size is within valid range [0,size]. More... | |
void | checkRange (const label start, const label len) const |
Check that start and length define a valid range. More... | |
void | checkIndex (const label i) const |
Check index is within valid range [0,size) More... | |
bool | uniform () const |
True if all entries have identical values, and list is non-empty. More... | |
label | find (const T &val, label pos=0) const |
Find index of the first occurrence of the value. More... | |
label | rfind (const T &val, label pos=-1) const |
Find index of the last occurrence of the value. More... | |
bool | found (const T &val, label pos=0) const |
True if the value if found in the list. More... | |
void | moveFirst (const label i) |
Move element to the first position. More... | |
void | moveLast (const label i) |
Move element to the last position. More... | |
void | swapFirst (const label i) |
Swap element with the first element. Fatal on an empty list. More... | |
void | swapLast (const label i) |
Swap element with the last element. Fatal on an empty list. More... | |
void | shallowCopy (const UList< T > &list) |
Copy the pointer and size held by the given UList. More... | |
void | deepCopy (const UList< T > &list) |
Copy elements of the given UList. Sizes must match! More... | |
template<class Addr > | |
void | deepCopy (const IndirectListBase< T, Addr > &list) |
Copy elements of the given indirect list. Sizes must match! More... | |
SubList< T > | slice (const label pos, label len=-1) |
Return SubList slice (non-const access) - no range checking. More... | |
const SubList< T > | slice (const label pos, label len=-1) const |
Return SubList slice (const access) - no range checking. More... | |
SubList< T > | slice (const labelRange &range) |
Return SubList slice (non-const access) - with range checking. More... | |
const SubList< T > | slice (const labelRange &range) const |
Return SubList slice (const access) - with range checking. More... | |
T & | operator[] (const label i) |
Return element of UList. More... | |
const T & | operator[] (const label i) const |
Return element of constant UList. More... | |
operator const Foam::List< T > & () const | |
Allow cast to a const List<T>&. More... | |
void | operator= (const T &val) |
Assignment of all entries to the given value. More... | |
void | operator= (const Foam::zero) |
Assignment of all entries to zero. More... | |
iterator | begin () noexcept |
Return an iterator to begin traversing the UList. More... | |
iterator | end () noexcept |
Return an iterator to end traversing the UList. More... | |
const_iterator | cbegin () const noexcept |
Return const_iterator to begin traversing the constant UList. More... | |
const_iterator | cend () const noexcept |
Return const_iterator to end traversing the constant UList. More... | |
const_iterator | begin () const noexcept |
Return const_iterator to begin traversing the constant UList. More... | |
const_iterator | end () const noexcept |
Return const_iterator to end traversing the constant UList. More... | |
reverse_iterator | rbegin () |
Return reverse_iterator to begin reverse traversing the UList. More... | |
reverse_iterator | rend () |
Return reverse_iterator to end reverse traversing the UList. More... | |
const_reverse_iterator | crbegin () const |
Return const_reverse_iterator to begin reverse traversing the UList. More... | |
const_reverse_iterator | crend () const |
Return const_reverse_iterator to end reverse traversing the UList. More... | |
const_reverse_iterator | rbegin () const |
Return const_reverse_iterator to begin reverse traversing the UList. More... | |
const_reverse_iterator | rend () const |
Return const_reverse_iterator to end reverse traversing the UList. More... | |
label | size () const noexcept |
The number of elements in the UList. More... | |
bool | empty () const noexcept |
True if the UList is empty (ie, size() is zero) More... | |
void | swap (UList< T > &list) |
Swap content with another UList of the same type in constant time. More... | |
bool | operator== (const UList< T > &a) const |
Equality operation on ULists of the same type. More... | |
bool | operator!= (const UList< T > &a) const |
The opposite of the equality operation. Takes linear time. More... | |
bool | operator< (const UList< T > &list) const |
Compare two ULists lexicographically. Takes linear time. More... | |
bool | operator> (const UList< T > &a) const |
Compare two ULists lexicographically. Takes linear time. More... | |
bool | operator<= (const UList< T > &a) const |
Return true if !(a > b). Takes linear time. More... | |
bool | operator>= (const UList< T > &a) const |
Return true if !(a < b). Takes linear time. More... | |
Istream & | readList (Istream &is) |
Read List contents from Istream. More... | |
void | writeEntry (const word &keyword, Ostream &os) const |
Write the List as a dictionary entry with keyword. More... | |
Ostream & | writeList (Ostream &os, const label shortLen=0) const |
Write List, with line-breaks in ASCII when length exceeds shortLen. More... | |
template<class TypeT = T> | |
std::enable_if< std::is_same< bool, TypeT >::value, bool >::type | test (const label i) const |
Test bool value at specified position, always false for out-of-range access. More... | |
template<class TypeT = T> | |
std::enable_if< std::is_same< bool, TypeT >::value, bool >::type | get (const label i) const |
Return bool value at specified position, always false for out-of-range access. More... | |
template<class TypeT = T> | |
std::enable_if< std::is_same< bool, TypeT >::value, bool >::type | unset (const label i) |
Unset the bool entry at specified position, always false for out-of-range access. More... | |
T & | first () |
Access first element of the list, position [0]. More... | |
const T & | first () const |
Access first element of the list. More... | |
T & | last () |
Access last element of the list, position [size()-1]. More... | |
const T & | last () const |
Access last element of the list, position [size()-1]. More... | |
template<> | |
Istream & | readList (Istream &is) |
Specialized list reading for character lists which always uses binary format. More... | |
template<> | |
Ostream & | writeList (Ostream &os, const label) const |
Specialized writeList for character lists which always uses binary format. More... | |
template<> | |
const bool & | operator[] (const label i) const |
template<> | |
Foam::UPstream::commsStruct & | operator[] (const label procID) |
template<> | |
const Foam::UPstream::commsStruct & | operator[] (const label procID) const |
template<> | |
UPstream::commsStruct & | operator[] (const label procID) |
template<> | |
const UPstream::commsStruct & | operator[] (const label procID) const |
template<> | |
Ostream & | writeList (Ostream &os, const label) const |
template<> | |
Istream & | readList (Istream &is) |
Public Attributes | |
motionTypes | motionType_ |
Motion type. More... | |
vector | n_ |
Patch normal direction. More... | |
vector | gHat_ |
Vertical direction. More... | |
scalar | initialDepth_ |
Initial water depth. More... | |
scalar | wavePeriod_ |
Wave period. More... | |
scalar | waveHeight_ |
Wave height. More... | |
scalar | wavePhase_ |
Wave phase. More... | |
scalar | waveAngle_ |
Wave angle. More... | |
scalar | waveLength_ |
Wave length. More... | |
scalar | startTime_ |
Start time. More... | |
scalar | rampTime_ |
Ramp time. More... | |
scalar | secondOrder_ |
On/off second order calculation switch. More... | |
label | nPaddle_ |
Number of wave paddles. More... | |
tensor | Rgl_ |
Rotation tensor from global to local system. More... | |
tensor | Rlg_ |
Rotation tensor from local to global system. More... | |
scalarField | xPaddle_ |
Paddle x co-ordinates / [m]. More... | |
scalarField | yPaddle_ |
Paddle y co-ordinates / [m]. More... | |
labelList | pointToPaddle_ |
Addressing from point patch index to paddle index. More... | |
labelList | faceToPaddle_ |
Addressing from patch face index to paddle index. More... | |
scalarField | x_ |
Patch face centre x co-ordinates / [m]. More... | |
scalarField | y_ |
Patch face centre y co-ordinates / [m]. More... | |
scalarField | z_ |
Patch face centre z co-ordinates / [m]. More... | |
scalar | zSpan_ |
Overall (point) span in z-direction / [m]. More... | |
scalarField | zMin_ |
Minimum z (point) height per patch face / [m]. More... | |
scalar | zMinGb_ |
Global Minimum z (point) / [m]. More... | |
scalarField | zMax_ |
Maximum z (point) height per patch face / [m]. More... | |
scalarField | waterDepthRef_ |
Calculated water depth at the patch. More... | |
scalar | firstTime = 0 |
Static Public Attributes | |
static const Enum< motionTypes > | motionTypeNames |
Names for motion types. More... | |
Static Public Attributes inherited from pointPatchFieldBase | |
static int | disallowGenericPatchField |
Debug switch to disallow the use of generic pointPatchField. More... | |
Static Public Attributes inherited from FieldBase | |
static const char *const | typeName |
Typename for Field. More... | |
static bool | allowConstructFromLargerSize = false |
Permit read construct from a larger size. More... | |
Additional Inherited Members | |
Static Public Member Functions inherited from pointPatchField< vector > | |
static autoPtr< pointPatchField< vector > > | New (const word &patchFieldType, const pointPatch &p, const DimensionedField< vector, pointMesh > &iF) |
Return a pointer to a new patchField created on freestore given. More... | |
static autoPtr< pointPatchField< vector > > | New (const word &patchFieldType, const word &actualPatchType, const pointPatch &p, const DimensionedField< vector, pointMesh > &iF) |
Return a pointer to a new patchField created on freestore given. More... | |
static autoPtr< pointPatchField< vector > > | New (const pointPatchField< vector > &, const pointPatch &, const DimensionedField< vector, pointMesh > &, const pointPatchFieldMapper &) |
Return a pointer to a new patchField created on freestore from. More... | |
static autoPtr< pointPatchField< vector > > | New (const pointPatch &, const DimensionedField< vector, pointMesh > &, const dictionary &) |
Return a pointer to a new patchField created on freestore. More... | |
static autoPtr< pointPatchField< vector > > | NewCalculatedType (const pointPatchField< Type2 > &) |
Return a pointer to a new calculatedPointPatchField created on. More... | |
static const word & | calculatedType () |
The type name for calculated patch fields. More... | |
static const word & | zeroGradientType () |
The type name for zeroGradient patch fields. More... | |
Static Public Member Functions inherited from Field< vector > | |
static const Field< vector > & | null () |
Return nullObject reference Field. More... | |
static autoPtr< Field< vector > > | New (Istream &is) |
Return a pointer to a new Field created on freestore. More... | |
static tmp< Field< vector > > | NewCalculatedType (const Field< Type2 > &f) |
Return a pointer to a new calculatedFvPatchFieldField created on freestore without setting patchField values. More... | |
Static Public Member Functions inherited from List< vector > | |
static const List< vector > & | null () |
Return a null List. More... | |
Static Public Member Functions inherited from UList< T > | |
static const UList< T > & | null () |
Return a UList reference to a nullObject. More... | |
static constexpr label | max_size () noexcept |
The size of the largest possible UList. More... | |
Protected Member Functions inherited from pointPatchFieldBase | |
virtual void | readDict (const dictionary &dict) |
Read dictionary entries. More... | |
void | setUpdated (bool state) noexcept |
Set updated state. More... | |
Protected Member Functions inherited from UList< T > | |
void | setAddressableSize (const label n) noexcept |
Set addressed size to be inconsistent with allocated storage. More... | |
void | size (const label n) |
Older name for setAddressableSize. More... | |
void | writeEntry (Ostream &os) const |
Write the UList with its compound type. More... | |
labelRange | validateRange (const labelRange &requestedRange) const |
Return a validated (start,size) subset range, which means that it always addresses a valid section of the list. More... | |
UList< T > & | operator= (const UList< T > &)=delete |
No copy assignment (default: shallow copy) More... | |
template<> | |
void | writeEntry (Ostream &os) const |
Specialized writeEntry for character lists which always uses binary format. More... | |
template<> | |
void | writeEntry (Ostream &os) const |
Point motion boundary condition to generate waves based on either piston or flap motions.
Hughes, S.A. (1993). Physical Models And Laboratory Techniques In Coastal Engineering. Advanced Series On Ocean Engineering, volume 7
leftwall { type waveMaker; motionType flap; n (1 0 0); initialDepth 0.25; wavePeriod 2.0; waveHeight 0.06; wavePhase 0; rampTime 2.0; }
where
Property | Description | Required | Default value |
---|---|---|---|
motionType | See motion types below | yes | |
n | Direction of motion | yes | |
initialDepth | Initial depth | yes | |
wavePeriod | wave period | yes | |
waveHeight | Wave height | yes | |
wavePhase | wave phase | yes | |
waveAngle | wave angle | no | 0 |
startTime | Start time | no | case start time |
rampTime | Time to reach maximum motion | yes | |
secondOrder | Second order calculation | no | no |
nPaddle | Number of paddles | no | 1 |
Available motion types include:
Definition at line 153 of file waveMakerPointPatchVectorField.H.
enum motionTypes |
Enumerator | |
---|---|
piston | |
flap | |
solitary |
Definition at line 159 of file waveMakerPointPatchVectorField.H.
waveMakerPointPatchVectorField | ( | const pointPatch & | p, |
const DimensionedField< vector, pointMesh > & | iF | ||
) |
Construct from patch and internal field.
Definition at line 134 of file waveMakerPointPatchVectorField.C.
Referenced by waveMakerPointPatchVectorField::clone().
waveMakerPointPatchVectorField | ( | const pointPatch & | p, |
const DimensionedField< vector, pointMesh > & | iF, | ||
const dictionary & | dict | ||
) |
Construct from patch, internal field and dictionary.
Definition at line 156 of file waveMakerPointPatchVectorField.C.
References dict, Foam::exit(), Foam::FatalIOError, FatalIOErrorInFunction, dictionary::found(), g, Foam::mag(), and Foam::constant::mathematical::pi().
waveMakerPointPatchVectorField | ( | const waveMakerPointPatchVectorField & | ptf, |
const pointPatch & | p, | ||
const DimensionedField< vector, pointMesh > & | iF, | ||
const pointPatchFieldMapper & | mapper | ||
) |
Construct by mapping given patchField<vector> onto a new patch.
Definition at line 216 of file waveMakerPointPatchVectorField.C.
waveMakerPointPatchVectorField | ( | const waveMakerPointPatchVectorField & | ptf, |
const DimensionedField< vector, pointMesh > & | iF | ||
) |
Construct as copy setting internal field reference.
Definition at line 240 of file waveMakerPointPatchVectorField.C.
const Foam::vector & g | ( | ) |
Return the gravitational acceleration.
Definition at line 46 of file waveMakerPointPatchVectorField.C.
References pointPatchFieldBase::db(), Foam::exit(), Foam::FatalError, FatalErrorInFunction, Foam::mag(), gravity::New(), and dimensioned< Type >::value().
|
virtual |
Dispersion equation.
Definition at line 63 of file waveMakerPointPatchVectorField.C.
References g, Foam::constant::universal::h, L(), Foam::mag(), Foam::T(), Foam::tanh(), and Foam::constant::mathematical::twoPi().
|
virtual |
Return the time scaling coefficient.
Definition at line 81 of file waveMakerPointPatchVectorField.C.
References Foam::max(), and Foam::min().
|
virtual |
Initialise.
Definition at line 89 of file waveMakerPointPatchVectorField.C.
References Cp, forAll, boundBox::max(), boundBox::min(), Foam::foamVersion::patch, Foam::reduce(), xMax, and xMin.
TypeName | ( | "waveMaker" | ) |
Runtime type information.
|
inlinevirtual |
Construct and return a clone.
Reimplemented from fixedValuePointPatchField< vector >.
Definition at line 382 of file waveMakerPointPatchVectorField.H.
References waveMakerPointPatchVectorField::waveMakerPointPatchVectorField().
|
inlinevirtual |
Construct and return a clone setting internal field reference.
Reimplemented from fixedValuePointPatchField< vector >.
Definition at line 406 of file waveMakerPointPatchVectorField.H.
References waveMakerPointPatchVectorField::waveMakerPointPatchVectorField().
|
virtual |
Update the coefficients associated with the patch field.
Reimplemented from valuePointPatchField< vector >.
Definition at line 263 of file waveMakerPointPatchVectorField.C.
References Foam::abort(), Field< Type >::component(), Foam::cos(), Foam::cosh(), Foam::endl(), Foam::FatalError, FatalErrorInFunction, forAll, g, Foam::constant::universal::hr, Foam::Info, Foam::constant::electromagnetic::kappa, Foam::mag(), Field< Type >::operator=(), Foam::foamVersion::patch, Foam::constant::mathematical::pi(), points, Foam::pow3(), sigma(), Foam::sin(), Foam::sinh(), Foam::sqr(), Foam::sqrt(), Foam::tanh(), Foam::constant::mathematical::twoPi(), and valuePointPatchField< Type >::updateCoeffs().
|
virtual |
Write.
Reimplemented from valuePointPatchField< vector >.
Definition at line 442 of file waveMakerPointPatchVectorField.C.
References os(), pointPatchField< Type >::write(), and Ostream::writeEntry().
|
static |
Names for motion types.
Definition at line 169 of file waveMakerPointPatchVectorField.H.
motionTypes motionType_ |
Motion type.
Definition at line 177 of file waveMakerPointPatchVectorField.H.
vector n_ |
Patch normal direction.
Note: cannot use patch normal of the initial patch unless it is in its neutral position (flap mode)
Definition at line 185 of file waveMakerPointPatchVectorField.H.
vector gHat_ |
Vertical direction.
Definition at line 190 of file waveMakerPointPatchVectorField.H.
scalar initialDepth_ |
Initial water depth.
Definition at line 195 of file waveMakerPointPatchVectorField.H.
scalar wavePeriod_ |
Wave period.
Definition at line 200 of file waveMakerPointPatchVectorField.H.
scalar waveHeight_ |
Wave height.
Definition at line 205 of file waveMakerPointPatchVectorField.H.
scalar wavePhase_ |
Wave phase.
Definition at line 210 of file waveMakerPointPatchVectorField.H.
scalar waveAngle_ |
Wave angle.
Definition at line 215 of file waveMakerPointPatchVectorField.H.
scalar waveLength_ |
Wave length.
Definition at line 220 of file waveMakerPointPatchVectorField.H.
scalar startTime_ |
Start time.
Definition at line 225 of file waveMakerPointPatchVectorField.H.
scalar rampTime_ |
Ramp time.
Definition at line 230 of file waveMakerPointPatchVectorField.H.
scalar secondOrder_ |
On/off second order calculation switch.
Definition at line 235 of file waveMakerPointPatchVectorField.H.
label nPaddle_ |
Number of wave paddles.
Definition at line 240 of file waveMakerPointPatchVectorField.H.
tensor Rgl_ |
Rotation tensor from global to local system.
Definition at line 245 of file waveMakerPointPatchVectorField.H.
tensor Rlg_ |
Rotation tensor from local to global system.
Definition at line 250 of file waveMakerPointPatchVectorField.H.
scalarField xPaddle_ |
Paddle x co-ordinates / [m].
Definition at line 255 of file waveMakerPointPatchVectorField.H.
scalarField yPaddle_ |
Paddle y co-ordinates / [m].
Definition at line 260 of file waveMakerPointPatchVectorField.H.
labelList pointToPaddle_ |
Addressing from point patch index to paddle index.
Definition at line 265 of file waveMakerPointPatchVectorField.H.
labelList faceToPaddle_ |
Addressing from patch face index to paddle index.
Definition at line 270 of file waveMakerPointPatchVectorField.H.
scalarField x_ |
Patch face centre x co-ordinates / [m].
Definition at line 275 of file waveMakerPointPatchVectorField.H.
scalarField y_ |
Patch face centre y co-ordinates / [m].
Definition at line 280 of file waveMakerPointPatchVectorField.H.
scalarField z_ |
Patch face centre z co-ordinates / [m].
Definition at line 285 of file waveMakerPointPatchVectorField.H.
scalar zSpan_ |
Overall (point) span in z-direction / [m].
Definition at line 290 of file waveMakerPointPatchVectorField.H.
scalarField zMin_ |
Minimum z (point) height per patch face / [m].
Definition at line 295 of file waveMakerPointPatchVectorField.H.
scalar zMinGb_ |
Global Minimum z (point) / [m].
Definition at line 300 of file waveMakerPointPatchVectorField.H.
scalarField zMax_ |
Maximum z (point) height per patch face / [m].
Definition at line 305 of file waveMakerPointPatchVectorField.H.
scalarField waterDepthRef_ |
Calculated water depth at the patch.
Definition at line 310 of file waveMakerPointPatchVectorField.H.
scalar firstTime = 0 |
Definition at line 313 of file waveMakerPointPatchVectorField.H.
Copyright © 2011-2018 OpenFOAM | OPENFOAM® is a registered trademark of OpenCFD Ltd.