Point motion boundary condition to generate waves based on either piston or flap motions. More...

#include <waveMakerPointPatchVectorField.H>

Inheritance diagram for waveMakerPointPatchVectorField:

Collaboration diagram for waveMakerPointPatchVectorField:

[legend]

Public Types
enum	motionTypes { piston , flap , solitary }
Public Types inherited from pointPatchField< vector >
typedef pointPatch	Patch
	The patch type for the patch field.
typedef vector	value_type
	The value_type for the patch field.
typedef pTraits< vector >::cmptType	cmptType
	The component type for patch field.
typedef DimensionedField< vector, pointMesh >	Internal
	The internal field type associated with the patch field.
typedef calculatedPointPatchField< vector >	Calculated
	Type for a calculated patch.
Public Types inherited from Field< vector >
typedef pTraits< vector >::cmptType	cmptType
	Component type.
typedef SubField< vector >	subField
	Declare type of subField.
Public Types inherited from List< vector >
typedef SubList< vector >	subList
	Declare type of subList.
Public Types inherited from UList< vector >
typedef vector	value_type
	The value type the list contains.
typedef vector *	pointer
	The pointer type for non-const access to value_type items.
typedef const vector *	const_pointer
	The pointer type for const access to value_type items.
typedef vector &	reference
	The type used for storing into value_type objects.
typedef const vector &	const_reference
	The type used for reading from constant value_type objects.
typedef vector *	iterator
	Random access iterator for traversing a UList.
typedef const vector *	const_iterator
	Random access iterator for traversing a UList.
typedef label	size_type
	The type to represent the size of a UList.
typedef label	difference_type
	The difference between iterator objects.
typedef std::reverse_iterator< iterator >	reverse_iterator
	Reverse iterator (non-const access).
typedef std::reverse_iterator< const_iterator >	const_reverse_iterator
	Reverse iterator (const access).
using	is_List
	Have unique tag.

Public Member Functions
const vector &	g ()
	Return the gravitational acceleration.
virtual scalar	waveLength (const scalar h, const scalar T)
	Dispersion equation.
virtual scalar	timeCoeff (const scalar t) const
	Return the time scaling coefficient.
virtual void	initialiseGeometry ()
	Initialise.
	TypeName ("waveMaker")
	Runtime type information.
	waveMakerPointPatchVectorField (const pointPatch &, const DimensionedField< vector, pointMesh > &)
	Construct from patch and internal field.
	waveMakerPointPatchVectorField (const pointPatch &, const DimensionedField< vector, pointMesh > &, const dictionary &)
	Construct from patch, internal field and dictionary.
	waveMakerPointPatchVectorField (const waveMakerPointPatchVectorField &, const pointPatch &, const DimensionedField< vector, pointMesh > &, const pointPatchFieldMapper &)
	Construct by mapping given patch field onto a new patch.
	waveMakerPointPatchVectorField (const waveMakerPointPatchVectorField &, const DimensionedField< vector, pointMesh > &)
	Construct as copy setting internal field reference.
virtual autoPtr< pointPatchField< vector > >	clone () const
	Return a clone.
virtual autoPtr< pointPatchField< vector > >	clone (const DimensionedField< vector, pointMesh > &iF) const
	Construct and return a clone setting internal field reference.
virtual void	updateCoeffs ()
	Update the coefficients associated with the patch field.
virtual void	write (Ostream &) const
	Write.
Public Member Functions inherited from fixedValuePointPatchField< vector >
	TypeName ("fixedValue")
	Runtime type information.
	fixedValuePointPatchField (const pointPatch &, const DimensionedField< vector, pointMesh > &)
	Construct from patch and internal field.
virtual bool	fixesValue () const
	True: this patch field fixes a value.
virtual bool	assignable () const
	False: this patch field is not altered by assignment.
virtual void	operator= (const Field< vector > &)
Public Member Functions inherited from valuePointPatchField< vector >
	TypeName ("value")
	Declare type-name, virtual type (with debug switch).
	valuePointPatchField (const valuePointPatchField &)=default
	Copy construct.
label	size () const noexcept
	Return the field size.
virtual void	autoMap (const pointPatchFieldMapper &)
	Map (and resize as needed) from self given a mapping object.
virtual void	rmap (const pointPatchField< vector > &, const labelList &)
	Reverse map the given PointPatchField onto.
virtual void	evaluate (const Pstream::commsTypes commsType=Pstream::commsTypes::buffered)
	Evaluate the patch field.
virtual void	operator= (const valuePointPatchField< vector > &)
virtual void	operator== (const valuePointPatchField< vector > &)
bool	operator!= (const valuePointPatchField< vector > &) const=delete
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.
	pointPatchField (const pointPatch &, const DimensionedField< vector, pointMesh > &, const dictionary &)
	Construct from patch, internal field and dictionary.
	pointPatchField (const pointPatchField< vector > &, const pointPatch &, const DimensionedField< vector, pointMesh > &, const pointPatchFieldMapper &)
	Construct by mapping given patch field onto a new patch.
	pointPatchField (const pointPatchField< vector > &pfld, const pointPatch &p, const DimensionedField< vector, pointMesh > &iF, const vector &value)
	Copy construct onto a new patch with (unused) value.
	pointPatchField (const pointPatchField< vector > &pfld, const DimensionedField< vector, pointMesh > &iF)
	Copy construct with internal field reference.
	pointPatchField (const pointPatchField< vector > &pfld)
	Copy construct.
virtual	~pointPatchField ()=default
	Destructor.
label	size () const noexcept
	Return the patch size.
const DimensionedField< vector, pointMesh > &	internalField () const noexcept
	Return const-reference to the dimensioned internal field.
const Field< vector > &	primitiveField () const noexcept
	Return const-reference to the internal field values.
void	patchInternalField (const UList< Type1 > &internalData, const labelUList &addressing, UList< Type1 > &pfld) const
	Extract field using specified addressing.
tmp< Field< Type1 > >	patchInternalField (const UList< Type1 > &internalData, const labelUList &addressing) const
	Return field created from selected internal field values given internal field reference.
tmp< Field< Type1 > >	patchInternalField (const UList< Type1 > &internalData) const
	Return field created from appropriate internal field values given internal field reference.
tmp< Field< vector > >	patchInternalField () const
	Return field created from appropriate internal field values.
void	addToInternalField (Field< Type1 > &iF, const Field< Type1 > &pF) const
	Given the internal field and a patch field, add the patch field to the internal field.
void	addToInternalField (Field< Type1 > &iF, const Field< Type1 > &pF, const labelUList &points) const
	Given the internal field and a patch field, add selected elements of the patch field to the internal field.
void	setInInternalField (Field< Type1 > &iF, const Field< Type1 > &pF, const labelUList &meshPoints) const
	Given the internal field and a patch field, set the patch field in the internal field.
void	setInInternalField (Field< Type1 > &iF, const Field< Type1 > &pF) const
	Given the internal field and a patch field, set the patch field in the internal field.
virtual void	rmap (const pointPatchField< vector > &, const labelList &)
	Reverse map the given pointPatchField onto this pointPatchField.
virtual void	initEvaluate (const Pstream::commsTypes commsType=Pstream::commsTypes::buffered)
	Initialise evaluation of the patch field (do nothing).
virtual void	initEvaluateLocal (const Pstream::commsTypes commsType=Pstream::commsTypes::buffered)
	Initialise the evaluation of the patch field after a local operation.
virtual void	evaluateLocal (const Pstream::commsTypes commsType=Pstream::commsTypes::buffered)
	Evaluate the patch field after a local operation (e.g. *=).
virtual void	operator= (const pointPatchField< vector > &)
virtual void	operator+= (const pointPatchField< vector > &)
virtual void	operator-= (const pointPatchField< vector > &)
virtual void	operator*= (const pointPatchField< scalar > &)
virtual void	operator/= (const pointPatchField< scalar > &)
virtual void	operator+= (const Field< vector > &)
virtual void	operator-= (const Field< vector > &)
virtual void	operator*= (const Field< scalar > &)
virtual void	operator/= (const Field< scalar > &)
virtual void	operator= (const vector &)
virtual void	operator+= (const vector &)
virtual void	operator-= (const vector &)
virtual void	operator*= (const scalar)
virtual void	operator/= (const scalar)
virtual void	operator== (const pointPatchField< vector > &)
virtual void	operator== (const Field< vector > &)
virtual void	operator== (const vector &)
bool	operator!= (const pointPatchField< vector > &) const=delete
bool	operator!= (const Field< vector > &) const=delete
bool	operator!= (const vector &) const=delete
void	negate ()
	Negate the field inplace. Dummy placeholder for FieldField.
void	normalise ()
	Normalise the field inplace. Dummy placeholder for FieldField.
Foam::autoPtr< Foam::pointPatchField< vector > >	NewCalculatedType (const pointPatchField< AnyType > &pf)
Foam::tmp< Foam::Field< Type1 > >	patchInternalField (const UList< Type1 > &internalData, const labelUList &addressing) const
Foam::tmp< Foam::Field< Type1 > >	patchInternalField (const UList< Type1 > &internalData) const
Public Member Functions inherited from pointPatchFieldBase
	TypeName ("pointPatchField")
	Runtime type information.
	pointPatchFieldBase (const pointPatch &p)
	Construct from patch.
	pointPatchFieldBase (const pointPatch &p, const word &patchType)
	Construct from patch and patch type.
	pointPatchFieldBase (const pointPatch &p, const dictionary &dict)
	Construct from patch and dictionary.
	pointPatchFieldBase (const pointPatchFieldBase &, const pointPatch &p)
	Copy construct with new patch.
	pointPatchFieldBase (const pointPatchFieldBase &)
	Copy construct.
virtual	~pointPatchFieldBase ()=default
	Destructor.
virtual bool	coupled () const
	True if the patch field is coupled.
virtual const word &	constraintType () const
	The constraint type the pointPatchField implements.
const objectRegistry &	db () const
	The associated objectRegistry.
const pointPatch &	patch () const noexcept
	Return the patch.
const word &	patchType () const noexcept
	The optional patch type.
word &	patchType () noexcept
	The optional patch type.
virtual bool	constraintOverride () const
	True if the type does not correspond to the constraint type.
bool	updated () const noexcept
	True if the boundary condition has already been updated.
void	setUpdated (bool state) noexcept
	Set updated state.
bool	manipulatedMatrix () const noexcept
	True if the matrix has already been manipulated. Currently always false for pointPatchField.
void	setManipulated (bool state) noexcept
	Set matrix manipulated state. Currently a no-op for pointPatchField.
void	checkPatch (const pointPatchFieldBase &rhs) const
	Check that patches are identical.
Public Member Functions inherited from Field< vector >
constexpr	Field () noexcept
	Default construct.
	Field (const label len)
	Construct given size.
	Field (const label len, const vector &val)
	Construct given size and initial value.
	Field (const label len, Foam::zero)
	Construct given size and initial values of zero.
	Field (Foam::one, const vector &val)
	Construct with length=1, copying the value as the only content.
	Field (Foam::one, vector &&val)
	Construct with length=1, moving the value as the only content.
	Field (Foam::one, Foam::zero)
	Construct with length=1, initializing content to zero.
	Field (const Field< vector > &fld)
	Copy construct.
	Field (const UList< vector > &list)
	Copy construct from UList<Type>.
	Field (const IndirectListBase< vector, Addr > &list)
	Copy construct from IndirectList.
	Field (Field< vector > &&fld) noexcept
	Move construct from Field.
	Field (List< vector > &&list) noexcept
	Move construct from List.
	Field (DynamicList< vector, SizeMin > &&list)
	Move construct from DynamicList.
	Field (const UList< vector > &mapF, const labelUList &mapAddressing)
	Construct by 1 to 1 mapping from the given field.
	Field (const tmp< Field< vector > > &tmapF, const labelUList &mapAddressing)
	Construct by 1 to 1 mapping from the given tmp field.
	Field (const UList< vector > &mapF, const labelListList &mapAddressing, const scalarListList &weights)
	Construct by interpolative mapping from the given field.
	Field (const tmp< Field< vector > > &tmapF, const labelListList &mapAddressing, const scalarListList &weights)
	Construct by interpolative mapping from the given tmp field.
	Field (const UList< vector > &mapF, const FieldMapper &map, const bool applyFlip=true)
	Construct by mapping from the given field.
	Field (const UList< vector > &mapF, const FieldMapper &map, const vector &defaultValue, const bool applyFlip=true)
	Construct by mapping from the given field.
	Field (const UList< vector > &mapF, const FieldMapper &map, const UList< vector > &defaultValues, const bool applyFlip=true)
	Construct by mapping from the given field.
	Field (const tmp< Field< vector > > &tmapF, const FieldMapper &map, const bool applyFlip=true)
	Construct by mapping from the given tmp field.
	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.
	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.
	Field (Field< vector > &fld, bool reuse)
	Copy construct or re-use as specified.
	Field (const tmp< Field< vector > > &tfld)
	Copy or move construct from tmp.
	Field (Istream &is)
	Construct from Istream.
	Field (const entry &e, const label len)
	Construct from a dictionary (primitive) entry.
	Field (const word &key, const dictionary &dict, const label len, IOobjectOption::readOption readOpt=IOobjectOption::MUST_READ)
	Lookup of a primitive dictionary entry by (literal) name and assign its contents to this. The behaviour largely as described in assign():
tmp< Field< vector > >	clone () const
	Clone.
void	assign (const entry &e, const label len)
	Assign from a primitive dictionary entry with the following behaviour:
bool	assign (const word &key, const dictionary &dict, const label len, IOobjectOption::readOption readOpt=IOobjectOption::MUST_READ)
	Lookup a primitive dictionary entry by (literal) name and assign its contents to this (behaviour as described above).
void	map (const UList< vector > &mapF, const labelUList &mapAddressing)
	1 to 1 map from the given field
void	map (const tmp< Field< vector > > &tmapF, const labelUList &mapAddressing)
	1 to 1 map from the given tmp field
void	map (const UList< vector > &mapF, const labelListList &mapAddressing, const scalarListList &weights)
	Interpolative map from the given field.
void	map (const tmp< Field< vector > > &tmapF, const labelListList &mapAddressing, const scalarListList &weights)
	Interpolative map from the given tmp field.
void	map (const UList< vector > &mapF, const FieldMapper &map, const bool applyFlip=true)
	Map from the given field.
void	map (const tmp< Field< vector > > &tmapF, const FieldMapper &map, const bool applyFlip=true)
	Map from the given tmp field.
void	autoMap (const FieldMapper &map, const bool applyFlip=true)
	Map from self.
void	rmap (const UList< vector > &mapF, const labelUList &mapAddressing)
	1 to 1 reverse-map from the given field
void	rmap (const tmp< Field< vector > > &tmapF, const labelUList &mapAddressing)
	1 to 1 reverse-map from the given tmp field
void	rmap (const UList< vector > &mapF, const labelUList &mapAddressing, const UList< scalar > &weights)
	Interpolative reverse map from the given field.
void	rmap (const tmp< Field< vector > > &tmapF, const labelUList &mapAddressing, const UList< scalar > &weights)
	Interpolative reverse map from the given tmp field.
void	negate ()
	Inplace negate this field (negative).
void	normalise ()
	Inplace normalise this field. Generally a no-op except for vector fields.
tmp< Field< cmptType > >	component (const direction) const
	Return a component field of the field.
void	replace (const direction, const UList< cmptType > &)
	Replace a component field of the field.
void	replace (const direction, const tmp< Field< cmptType > > &)
	Replace a component field of the field.
void	replace (const direction, const cmptType &)
	Replace a component field of the field.
void	clamp_min (const vector &lower)
	Impose lower (floor) clamp on the field values (in-place).
void	clamp_min (const UList< vector > &lower)
	Impose lower (floor) clamp on the field values (in-place).
void	clamp_max (const vector &upper)
	Impose upper (ceiling) clamp on the field values (in-place).
void	clamp_max (const UList< vector > &upper)
	Impose upper (ceiling) clamp on the field values (in-place).
void	clamp_range (const vector &lower, const vector &upper)
	Clamp field values (in-place) to the specified range.
void	clamp_range (const MinMax< vector > &range)
	Clamp field values (in-place) to the specified range.
VSForm	block (const label start) const
tmp< Field< vector > >	T () const
	Return the field transpose (only defined for second rank tensors).
void	writeEntry (const word &keyword, Ostream &os) const
	Write the field as a dictionary entry.
SubField< vector >	slice (const label pos, label len=-1)
	Return SubField slice (non-const access) - no range checking.
const SubField< vector >	slice (const label pos, label len=-1) const
	Return SubField slice (const access) - no range checking.
SubField< vector >	slice (const labelRange &range)
	Return SubField slice (non-const access) - with range checking.
const SubField< vector >	slice (const labelRange &range) const
	Return SubField slice (const access) - with range checking.
void	operator= (const Field< vector > &)
	Copy assignment.
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.
void	operator= (Field< vector > &&rhs)
	Move assignment.
void	operator= (List< vector > &&rhs)
void	operator= (DynamicList< vector, SizeMin > &&rhs)
void	operator= (const vector &val)
	Assign entries to the given value.
void	operator= (Foam::zero)
	Assign entries to zero.
void	operator= (const VectorSpace< Form, Cmpt, nCmpt > &)
void	operator+= (const UList< vector > &)
void	operator+= (const tmp< Field< vector > > &)
void	operator-= (const UList< vector > &)
void	operator-= (const tmp< Field< vector > > &)
void	operator*= (const UList< scalar > &)
void	operator*= (const tmp< Field< scalar > > &)
void	operator/= (const UList< scalar > &)
void	operator/= (const tmp< Field< scalar > > &)
void	operator+= (const vector &)
void	operator-= (const vector &)
void	operator*= (const scalar &)
void	operator/= (const scalar &)
	Field (const Expression::ListExpression< E > &expr)
	Construct from value expression.
void	operator= (const Expression::ListExpression< E > &expr)
	Assign values from expression.
void	operator= (const tmp< Field > &rhs)
void	normalise ()
void	normalise ()
void	normalise ()
	Inplace normalise (float) vector field.
void	normalise ()
	Inplace normalise (double) vector field.
Public Member Functions inherited from FieldBase
constexpr	FieldBase () noexcept
	Default construct.
Public Member Functions inherited from refCount
constexpr	refCount () noexcept
	Default construct, initializing count to 0.
int	use_count () const noexcept
	Return the current reference count.
bool	unique () const noexcept
	Return true if the reference count is zero.
void	operator++ () noexcept
	Increment the reference count.
void	operator++ (int) noexcept
	Increment the reference count.
void	operator-- () noexcept
	Decrement the reference count.
void	operator-- (int) noexcept
	Decrement the reference count.
Public Member Functions inherited from List< vector >
constexpr	List () noexcept
	Default construct.
	List (const label len)
	Construct with given size.
	List (const label len, const vector &val)
	Construct with given size and value for all elements.
	List (const label len, Foam::zero)
	Construct with given size initializing all elements to zero.
	List (Foam::one, const vector &val)
	Construct with length=1, copying the value as the only content.
	List (Foam::one, vector &&val)
	Construct with length=1, moving the value as the only content.
	List (Foam::one, Foam::zero)
	Construct with length=1, initializing content to zero.
	List (const List< vector > &list)
	Copy construct from list.
	List (const UList< vector > &list)
	Copy construct contents from list.
	List (List< vector > &list, bool reuse)
	Construct as copy or re-use as specified.
	List (const UList< vector > &list, const labelUList &indices)
	Copy construct subset of list.
	List (const UList< vector > &list, const FixedList< label, N > &indices)
	Copy construct subset of list.
	List (const FixedList< vector, N > &list)
	Construct as copy of FixedList<T, N>.
	List (const UPtrList< vector > &list)
	Construct as copy of UPtrList<T> content.
	List (const IndirectListBase< vector, Addr > &list)
	Construct as copy of IndirectList contents.
	List (std::initializer_list< vector > list)
	Construct from an initializer list.
	List (List< vector > &&list) noexcept
	Move construct from List.
	List (DynamicList< vector, SizeMin > &&list)
	Move construct from DynamicList.
	List (Istream &is)
	Construct from Istream.
autoPtr< List< vector > >	clone () const
	Clone.
	~List ()
	Destructor.
void	clear ()
	Clear the list, i.e. set size to zero.
void	resize (const label len)
	Adjust allocated size of list.
void	resize (const label len, const vector &val)
	Adjust allocated size of list and set val for new elements.
void	resize_copy (label count, const label len)
	Change allocated size of list, retaining the first count elements.
void	resize_fill (const label len, const vector &val)
	Adjust allocated size of list and set val for all elements.
void	resize_nocopy (const label len)
	Adjust allocated size of list without necessarily.
void	transfer (List< vector > &list)
	Transfer the contents of the argument List into this list and annul the argument list.
void	transfer (DynamicList< vector, SizeMin > &list)
	Transfer the contents of the argument List into this list and annul the argument list.
vector &	newElmt (const label i)
	Return subscript-checked element of UList and resizing the list if required.
vector &	emplace_back (Args &&... args)
	Construct an element at the end of the list, return reference to the new list element.
void	push_back (const vector &val)
	Append an element at the end of the list.
void	push_back (vector &&val)
	Move append an element at the end of the list.
void	push_back (const UList< vector > &list)
	Append a List to the end of this list.
void	push_back (const IndirectListBase< vector, Addr > &list)
	Append IndirectList contents at the end of this list.
label	push_uniq (const vector &val)
	Append an element if not already in the list.
void	pop_back (label n=1)
	Reduce size by 1 or more elements. Can be called on an empty list.
void	operator= (const UList< vector > &list)
	Assignment to UList operator. Takes linear time.
void	operator= (const List< vector > &list)
	Assignment operator. Takes linear time.
void	operator= (const IndirectListBase< vector, Addr > &list)
	Assignment from IndirectList. Takes linear time.
void	operator= (const FixedList< vector, N > &list)
	Copy assignment from FixedList.
void	operator= (std::initializer_list< vector > list)
	Assignment to an initializer list.
void	operator= (const vector &val)
	Assignment of all entries to the given value.
void	operator= (Foam::zero)
	Assignment of all entries to zero.
void	operator= (List< vector > &&list)
	Move assignment. Takes constant time.
void	operator= (DynamicList< vector, SizeMin > &&list)
	Move assignment. Takes constant time.
Istream &	readList (Istream &is)
	Read List from Istream, discarding contents of existing List.
void	shallowCopy (const UList< vector > &)=delete
	No shallowCopy permitted.
bool	set (const label i, bool val=true)
	A bitSet::set() method for a list of bool.
void	append (const vector &val)
	Append an element at the end of the list.
void	append (vector &&val)
	Move append an element at the end of the list.
void	append (const UList< vector > &list)
	Append a List to the end of this list.
void	append (const IndirectListBase< vector, Addr > &list)
	Append IndirectList contents at the end of this list.
label	appendUniq (const vector &val)
	Same as push_uniq().
void	setSize (label n)
	Alias for resize().
void	setSize (label n, const vector &val)
	Alias for resize().
	List (const Expression::ListExpression< E > &expr)
	Construct from value expression.
void	operator= (const Expression::ListExpression< E > &expr)
	Assign values from expression.
void	resize (const label len)
Public Member Functions inherited from UList< vector >
	UList (const UList< vector > &) noexcept=default
	Copy construct, shallow copy.
	UList (UList< vector > &&) noexcept=default
	Move construct, shallow copy.
UList< vector > &	operator= (const UList< vector > &)=delete
	No copy assignment (default: shallow copy).
UList< vector > &	operator= (UList< vector > &&) noexcept=default
	Move assignment, shallow copy.
constexpr	UList () noexcept
	Default construct, zero-sized and nullptr.
	UList (vector *__restrict__ ptr, const label len) noexcept
	Construct from components.
	UList (SubList< vector > &&) noexcept
	Move construct from a SubList, shallow copy.
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.
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.
const vector &	fcValue (const label i) const
	Return forward circular value (ie, next value in the list).
vector &	fcValue (const label i)
	Return forward circular value (ie, next value in the list).
const vector &	rcValue (const label i) const
	Return reverse circular value (ie, previous value in the list).
vector &	rcValue (const label i)
	Return reverse circular value (ie, previous value in the list).
const vector *	cdata () const noexcept
	Return pointer to the underlying array serving as data storage.
vector *	data () noexcept
	Return pointer to the underlying array serving as data storage.
const char *	cdata_bytes () const noexcept
	Return pointer to the underlying array serving as data storage,.
char *	data_bytes () noexcept
	Return pointer to the underlying array serving as data storage,.
vector &	front ()
	Access first element of the list, position [0].
const vector &	front () const
	Access first element of the list.
vector &	back ()
	Access last element of the list, position [size()-1].
const vector &	back () const
	Access last element of the list, position [size()-1].
std::streamsize	size_bytes () const noexcept
	Number of contiguous bytes for the List data.
std::streamsize	byteSize () const
	Number of contiguous bytes for the List data, runtime FatalError if type is not contiguous.
void	checkStart (const label start) const
	Check start is within valid range [0,size).
void	checkSize (const label size) const
	Check size is within valid range [0,size].
void	checkRange (const label start, const label len) const
	Check that start and length define a valid range.
void	checkIndex (const label i) const
	Check index is within valid range [0,size).
bool	uniform () const
	True if all entries have identical values, and list is non-empty.
bool	contains (const vector &val) const
	True if the value is contained in the list.
bool	contains (const vector &val, label pos, label len=-1) const
	Is the value contained in the list?
label	find (const vector &val) const
	Find index of the first occurrence of the value.
label	find (const vector &val, label pos, label len=-1) const
	Find index of the first occurrence of the value.
label	rfind (const vector &val, label pos=-1) const
	Find index of the last occurrence of the value.
void	moveFirst (const label i)
	Move element to the first position.
void	moveLast (const label i)
	Move element to the last position.
void	swapFirst (const label i)
	Swap element with the first element. Fatal on an empty list.
void	swapLast (const label i)
	Swap element with the last element. Fatal on an empty list.
void	shallowCopy (vector *__restrict__ ptr, const label len) noexcept
	Copy the pointer and size.
void	shallowCopy (std::nullptr_t) noexcept
	Copy nullptr and zero size.
void	shallowCopy (const UList< vector > &list) noexcept
	Copy the pointer and size held by the given UList.
void	deepCopy (const UList< vector > &list)
	Copy elements of the given UList. Sizes must match!
void	deepCopy (const IndirectListBase< vector, Addr > &list)
	Copy elements of the given indirect list. Sizes must match!
SubList< vector >	slice (const label pos, label len=-1)
	Return SubList slice (non-const access) - no range checking.
const SubList< vector >	slice (const label pos, label len=-1) const
	Return SubList slice (const access) - no range checking.
SubList< vector >	slice (const labelRange &range)
	Return SubList slice (non-const access) - with range checking.
const SubList< vector >	slice (const labelRange &range) const
	Return SubList slice (const access) - with range checking.
vector &	operator[] (const label i)
	Return element of UList.
const vector &	operator[] (const label i) const
	Return element of constant UList.
	operator const Foam::List< vector > & () const
	Allow cast to a const List<T>&.
void	operator= (const vector &val)
	Assignment of all entries to the given value.
void	operator= (Foam::zero)
	Assignment of all entries to zero.
iterator	begin () noexcept
	Return an iterator to begin traversing the UList.
iterator	end () noexcept
	Return an iterator to end traversing the UList.
iterator	begin (const label i) noexcept
	Return iterator at offset i from begin, clamped to [0,size] range.
const_iterator	cbegin () const noexcept
	Return const_iterator to begin traversing the constant UList.
const_iterator	cend () const noexcept
	Return const_iterator to end traversing the constant UList.
const_iterator	begin () const noexcept
	Return const_iterator to begin traversing the constant UList.
const_iterator	end () const noexcept
	Return const_iterator to end traversing the constant UList.
const_iterator	cbegin (const label i) const noexcept
	Return const_iterator at offset i from begin, clamped to [0,size] range.
const_iterator	begin (const label i) const noexcept
	Return const_iterator at offset i from begin, clamped to [0,size] range.
reverse_iterator	rbegin ()
	Return reverse_iterator to begin reverse traversing the UList.
reverse_iterator	rend ()
	Return reverse_iterator to end reverse traversing the UList.
const_reverse_iterator	crbegin () const
	Return const_reverse_iterator to begin reverse traversing the UList.
const_reverse_iterator	crend () const
	Return const_reverse_iterator to end reverse traversing the UList.
const_reverse_iterator	rbegin () const
	Return const_reverse_iterator to begin reverse traversing the UList.
const_reverse_iterator	rend () const
	Return const_reverse_iterator to end reverse traversing the UList.
bool	empty () const noexcept
	True if List is empty (ie, size() is zero).
label	size () const noexcept
	The number of elements in the container.
label	capacity () const noexcept
	Size of the underlying storage.
void	swap (UList< vector > &list) noexcept
	Swap content with another UList of the same type in constant time.
bool	operator== (const UList< vector > &list) const
	Equality operation on ULists of the same type.
bool	operator!= (const UList< vector > &list) const
	The opposite of the equality operation. Takes linear time.
bool	operator< (const UList< vector > &list) const
	Compare two ULists lexicographically. Takes linear time.
bool	operator> (const UList< vector > &list) const
	Compare two ULists lexicographically. Takes linear time.
bool	operator<= (const UList< vector > &list) const
	Return true if !(a > b). Takes linear time.
bool	operator>= (const UList< vector > &list) const
	Return true if !(a < b). Takes linear time.
Istream &	readList (Istream &is)
	Read List contents from Istream.
void	writeEntry (const word &keyword, Ostream &os) const
	Write the List as a dictionary entry with keyword.
Ostream &	writeList (Ostream &os, const label shortLen=0) const
	Write List, with line-breaks in ASCII when length exceeds shortLen.
bool	all () const
	True if all entries are 'true' or if the list is empty.
bool	any () const
	True if any entries are 'true'.
bool	none () const
	True if no entries are 'true'.
bool	test (const label i) const
	Test `bool` value at specified position, always false for out-of-range access.
bool	get (const label i) const
	Return `bool` value at specified position, always false for out-of-range access.
bool	unset (const label i)
	Unset the `bool` entry at specified position, always false for out-of-range access.
std::string_view	view () const
	Return a string_view of the charList. Content is non-modifiable.
vector &	first ()
	Access first element of the list, position [0].
const vector &	first () const
	Access first element of the list.
vector &	last ()
	Access last element of the list, position [size()-1].
const vector &	last () const
	Access last element of the list, position [size()-1].
bool	found (const vector &val, label pos=0) const
	Same as contains().
auto	expr () const
	Wrap value as expression.
void	operator= (const Expression::ListExpression< E > &expr)
	Assign values from expression.
	operator const Foam::List< vector > & () const
	Allow cast to a const List<T>&.

Public Attributes
motionTypes	motionType_
	Motion type.
vector	n_
	Patch normal direction.
vector	gHat_
	Vertical direction.
scalar	initialDepth_
	Initial water depth.
scalar	wavePeriod_
	Wave period.
scalar	waveHeight_
	Wave height.
scalar	wavePhase_
	Wave phase.
scalar	waveAngle_
	Wave angle.
scalar	waveLength_
	Wave length.
scalar	startTime_
	Start time.
scalar	rampTime_
	Ramp time.
scalar	secondOrder_
	On/off second order calculation switch.
label	nPaddle_
	Number of wave paddles.
tensor	Rgl_
	Rotation tensor from global to local system.
tensor	Rlg_
	Rotation tensor from local to global system.
scalarField	xPaddle_
	Paddle x co-ordinates / [m].
scalarField	yPaddle_
	Paddle y co-ordinates / [m].
labelList	pointToPaddle_
	Addressing from point patch index to paddle index.
labelList	faceToPaddle_
	Addressing from patch face index to paddle index.
scalarField	x_
	Patch face centre x co-ordinates / [m].
scalarField	y_
	Patch face centre y co-ordinates / [m].
scalarField	z_
	Patch face centre z co-ordinates / [m].
scalar	zSpan_
	Overall (point) span in z-direction / [m].
scalarField	zMin_
	Minimum z (point) height per patch face / [m].
scalar	zMinGb_
	Global Minimum z (point) / [m].
scalarField	zMax_
	Maximum z (point) height per patch face / [m].
scalarField	waterDepthRef_
	Calculated water depth at the patch.
scalar	firstTime = 0

Static Public Attributes
static const Enum< motionTypes >	motionTypeNames
	Names for motion types.
Static Public Attributes inherited from pointPatchFieldBase
static int	disallowGenericPatchField
	Debug switch to disallow the use of generic pointPatchField.
Static Public Attributes inherited from FieldBase
static const char *const	typeName
	Typename for Field.
static bool	allowConstructFromLargerSize = false
	Permit read construct from a larger size.
static bool	unifiedGeometricField
	GeometricField with extra capacity for flattened boundary fields. Uses opt-switch "unifiedGeometricField".
static int	localBoundaryConsistency_
	Local boundary field consistency checks. Uses opt-switch "localBoundaryConsistency".
static scalar	localBoundaryTolerance_
	Tolerance for local boundary field consistency checks. Uses opt-switch "localBoundaryConsistency::tolerance".

Additional Inherited Members
Static Public Member Functions inherited from pointPatchField< vector >
static autoPtr< pointPatchField< vector > >	Clone (const DerivedPatchField &pf, Args &&... args)
	Clone a patch field, optionally with internal field reference etc.
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.
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.
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.
static autoPtr< pointPatchField< vector > >	New (const pointPatch &, const DimensionedField< vector, pointMesh > &, const dictionary &)
	Return a pointer to a new patchField created on freestore.
static autoPtr< pointPatchField< vector > >	NewCalculatedType (const pointPatch &p)
	Return a pointer to a new calculatedPointPatchField created on.
static autoPtr< pointPatchField< vector > >	NewCalculatedType (const pointPatchField< AnyType > &pf)
	Return a pointer to a new calculatedPointPatchField created on.
Static Public Member Functions inherited from pointPatchFieldBase
static const word &	emptyType () noexcept
	The type name for `empty` patch fields.
static const word &	calculatedType () noexcept
	The type name for `calculated` patch fields.
static const word &	zeroGradientType () noexcept
	The type name for `zeroGradient` patch fields.
static const word &	zeroValueType () noexcept
	The type name for `zeroValue` patch fields.
Static Public Member Functions inherited from Field< vector >
static const Field< vector > &	null () noexcept
	Return a null Field (reference to a nullObject). Behaves like an empty Field.
static autoPtr< Field< vector > >	New (Istream &is)
	Return a pointer to a new Field created on freestore.
static tmp< Field< vector > >	NewCalculatedType (const Field< Type2 > &f)
	Return a pointer to a new calculatedFvPatchFieldField created on freestore without setting patchField values.
Static Public Member Functions inherited from FieldBase
static void	warnLocalBoundaryConsistencyCompat (const dictionary &)
	Warn about keyword changes for local boundary consistency checks.
static int	localBoundaryConsistency () noexcept
	Get flag for local boundary consistency checks.
static int	localBoundaryConsistency (int val) noexcept
	Set flag for local boundary consistency checks.
Static Public Member Functions inherited from List< vector >
static const List< vector > &	null () noexcept
	Return a null List (reference to a nullObject). Behaves like an empty List.
Static Public Member Functions inherited from UList< vector >
static const UList< vector > &	null () noexcept
	Return a null UList (reference to a nullObject). Behaves like an empty UList.
static constexpr label	max_size () noexcept
	The size of the largest possible UList.
Protected Member Functions inherited from valuePointPatchField< vector >
bool	readValueEntry (const dictionary &dict, IOobjectOption::readOption readOpt=IOobjectOption::LAZY_READ)
	Read the "value" entry into `*this`.
void	writeValueEntry (Ostream &os) const
	Write `*this` field as a "value" entry.
void	extrapolateInternal ()
	Assign the patch field from the internal field.
Protected Member Functions inherited from pointPatchFieldBase
virtual void	readDict (const dictionary &dict)
	Read dictionary entries.
Protected Member Functions inherited from UList< vector >
void	setAddressableSize (const label n) noexcept
	Set addressed size to be inconsistent with allocated storage.
void	size (const label n)
	Older name for setAddressableSize.
void	writeEntry (Ostream &os) const
	Write the UList with its compound type.
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.
void	fill_uniform (const vector &val)
	Assign all entries to the given value.
void	fill_uniform (Foam::zero)
	Assign all entries to zero.

Detailed Description

Point motion boundary condition to generate waves based on either piston or flap motions.

Based on the reference

    Hughes, S.A. (1993).
    Physical Models And Laboratory Techniques In Coastal Engineering.
    Advanced Series On Ocean Engineering, volume 7

Usage

Example patch specification

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:

piston
flap
solitary

Source files

Definition at line 153 of file waveMakerPointPatchVectorField.H.

Member Enumeration Documentation

◆ motionTypes

enum motionTypes

Enumerator
piston
flap
solitary

Definition at line 159 of file waveMakerPointPatchVectorField.H.

Constructor & Destructor Documentation

◆ waveMakerPointPatchVectorField() [1/4]

waveMakerPointPatchVectorField	(	const pointPatch &	p,
		const DimensionedField< vector, pointMesh > &	iF )

Construct from patch and internal field.

Definition at line 133 of file waveMakerPointPatchVectorField.C.

References fixedValuePointPatchField< vector >::fixedValuePointPatchField(), gHat_, initialDepth_, motionType_, n_, nPaddle_, p, piston, rampTime_, secondOrder_, startTime_, waveAngle_, waveHeight_, wavePeriod_, wavePhase_, and Foam::Zero.

Referenced by TypeName(), waveMakerPointPatchVectorField(), and waveMakerPointPatchVectorField().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ waveMakerPointPatchVectorField() [2/4]

waveMakerPointPatchVectorField	(	const pointPatch &	p,
		const DimensionedField< vector, pointMesh > &	iF,
		const dictionary &	dict )

Construct from patch, internal field and dictionary.

Definition at line 155 of file waveMakerPointPatchVectorField.C.

References pointPatchFieldBase::db(), dict, Foam::exit(), Foam::FatalIOError, FatalIOErrorInFunction, fixedValuePointPatchField< vector >::fixedValuePointPatchField(), g(), UList< vector >::get(), gHat_, initialDepth_, initialiseGeometry(), Foam::mag(), motionType_, motionTypeNames, n_, nPaddle_, p, Foam::constant::mathematical::pi(), rampTime_, secondOrder_, startTime, startTime_, updateCoeffs(), waterDepthRef_, waveAngle_, waveHeight_, wavePeriod_, wavePhase_, and Foam::Zero.

Here is the call graph for this function:

◆ waveMakerPointPatchVectorField() [3/4]

waveMakerPointPatchVectorField	(	const waveMakerPointPatchVectorField &	ptf,
		const pointPatch &	p,
		const DimensionedField< vector, pointMesh > &	iF,
		const pointPatchFieldMapper &	mapper )

Construct by mapping given patch field onto a new patch.

Definition at line 215 of file waveMakerPointPatchVectorField.C.

References fixedValuePointPatchField< vector >::fixedValuePointPatchField(), gHat_, initialDepth_, motionType_, n_, nPaddle_, p, rampTime_, secondOrder_, startTime_, waveAngle_, waveHeight_, waveMakerPointPatchVectorField(), wavePeriod_, and wavePhase_.

Here is the call graph for this function:

◆ waveMakerPointPatchVectorField() [4/4]

waveMakerPointPatchVectorField	(	const waveMakerPointPatchVectorField &	ptf,
		const DimensionedField< vector, pointMesh > &	iF )

Construct as copy setting internal field reference.

Definition at line 239 of file waveMakerPointPatchVectorField.C.

References fixedValuePointPatchField< vector >::fixedValuePointPatchField(), gHat_, initialDepth_, motionType_, n_, nPaddle_, rampTime_, secondOrder_, startTime_, waveAngle_, waveHeight_, waveMakerPointPatchVectorField(), wavePeriod_, and wavePhase_.

Here is the call graph for this function:

Member Function Documentation

◆ g()

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().

Referenced by waveMakerPointPatchVectorField().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ waveLength()

Foam::scalar waveLength	(	const scalar	h,
		const scalar	T )

virtual

Dispersion equation.

Definition at line 62 of file waveMakerPointPatchVectorField.C.

References g, h, L, Foam::mag(), Foam::T(), Foam::tanh(), and Foam::constant::mathematical::twoPi().

Referenced by updateCoeffs().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ timeCoeff()

Foam::scalar timeCoeff ( const scalar t ) const

virtual

Return the time scaling coefficient.

Definition at line 80 of file waveMakerPointPatchVectorField.C.

References Foam::clamp(), and rampTime_.

Referenced by updateCoeffs().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ initialiseGeometry()

void initialiseGeometry ( )

virtual

Initialise.

Definition at line 89 of file waveMakerPointPatchVectorField.C.

References Cp, forAll, boundBox::max(), boundBox::min(), nPaddle_, pointPatchFieldBase::patch(), pointToPaddle_, Foam::reduce(), valuePointPatchField< vector >::size(), Vector< Cmpt >::x(), x_, xMax, xMin, xPaddle_, Vector< Cmpt >::y(), y_, yPaddle_, Vector< Cmpt >::z(), z_, zMinGb_, and zSpan_.

Referenced by waveMakerPointPatchVectorField().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ TypeName()

TypeName ( "waveMaker" )

Runtime type information.

References waveMakerPointPatchVectorField().

Here is the call graph for this function:

◆ clone() [1/2]

virtual autoPtr< pointPatchField< vector > > clone ( ) const

inlinevirtual

Return a clone.

Reimplemented from fixedValuePointPatchField< vector >.

Definition at line 391 of file waveMakerPointPatchVectorField.H.

References pointPatchField< Type >::Clone().

Here is the call graph for this function:

◆ clone() [2/2]

virtual autoPtr< pointPatchField< vector > > clone ( const DimensionedField< vector, pointMesh > & iF ) const

inlinevirtual

Construct and return a clone setting internal field reference.

Implements pointPatchField< vector >.

Definition at line 399 of file waveMakerPointPatchVectorField.H.

References pointPatchField< Type >::Clone().

Here is the call graph for this function:

◆ updateCoeffs()

void updateCoeffs ( )

virtual

Update the coefficients associated with the patch field.

Reimplemented from valuePointPatchField< vector >.

Definition at line 263 of file waveMakerPointPatchVectorField.C.

References Foam::abort(), Foam::cos(), Foam::cosh(), pointPatchFieldBase::db(), Foam::endl(), Foam::FatalError, FatalErrorInFunction, firstTime, flap, forAll, g, Foam::Info, initialDepth_, Foam::mag(), motionType_, motionTypeNames, n_, nPaddle_, Field< Type >::operator=(), pointPatchFieldBase::patch(), Foam::constant::mathematical::pi(), piston, points, pointToPaddle_, Foam::pow3(), secondOrder_, sigma(), Foam::sin(), Foam::sinh(), valuePointPatchField< vector >::size(), solitary, Foam::sqr(), Foam::sqrt(), startTime_, Foam::tanh(), timeCoeff(), Foam::constant::mathematical::twoPi(), valuePointPatchField< Type >::updateCoeffs(), pointPatchFieldBase::updated(), waterDepthRef_, waveAngle_, waveHeight_, waveLength(), waveLength_, wavePeriod_, xPaddle_, yPaddle_, and zMinGb_.

Referenced by waveMakerPointPatchVectorField().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ write()

void write ( Ostream & os ) const

virtual

Write.

Reimplemented from valuePointPatchField< vector >.

Definition at line 442 of file waveMakerPointPatchVectorField.C.

References initialDepth_, motionType_, motionTypeNames, n_, nPaddle_, os(), rampTime_, secondOrder_, startTime_, waveAngle_, waveHeight_, wavePeriod_, wavePhase_, pointPatchField< Type >::write(), and valuePointPatchField< vector >::writeValueEntry().

Here is the call graph for this function:

Member Data Documentation

◆ motionTypeNames

const Foam::Enum< Foam::waveMakerPointPatchVectorField::motionTypes > motionTypeNames

static

Names for motion types.

Definition at line 169 of file waveMakerPointPatchVectorField.H.

Referenced by updateCoeffs(), waveMakerPointPatchVectorField(), and write().

◆ motionType_

motionTypes motionType_

Motion type.

Definition at line 177 of file waveMakerPointPatchVectorField.H.

Referenced by updateCoeffs(), waveMakerPointPatchVectorField(), waveMakerPointPatchVectorField(), waveMakerPointPatchVectorField(), waveMakerPointPatchVectorField(), and write().

◆ n_

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.

Referenced by updateCoeffs(), waveMakerPointPatchVectorField(), waveMakerPointPatchVectorField(), waveMakerPointPatchVectorField(), waveMakerPointPatchVectorField(), and write().

◆ gHat_

vector gHat_

Vertical direction.

Definition at line 190 of file waveMakerPointPatchVectorField.H.

Referenced by waveMakerPointPatchVectorField(), waveMakerPointPatchVectorField(), waveMakerPointPatchVectorField(), and waveMakerPointPatchVectorField().

◆ initialDepth_

scalar initialDepth_

Initial water depth.

Definition at line 195 of file waveMakerPointPatchVectorField.H.

Referenced by updateCoeffs(), waveMakerPointPatchVectorField(), waveMakerPointPatchVectorField(), waveMakerPointPatchVectorField(), waveMakerPointPatchVectorField(), and write().

◆ wavePeriod_

scalar wavePeriod_

Wave period.

Definition at line 200 of file waveMakerPointPatchVectorField.H.

Referenced by updateCoeffs(), waveMakerPointPatchVectorField(), waveMakerPointPatchVectorField(), waveMakerPointPatchVectorField(), waveMakerPointPatchVectorField(), and write().

◆ waveHeight_

scalar waveHeight_

Wave height.

Definition at line 205 of file waveMakerPointPatchVectorField.H.

Referenced by updateCoeffs(), waveMakerPointPatchVectorField(), waveMakerPointPatchVectorField(), waveMakerPointPatchVectorField(), waveMakerPointPatchVectorField(), and write().

◆ wavePhase_

scalar wavePhase_

Wave phase.

Definition at line 210 of file waveMakerPointPatchVectorField.H.

Referenced by waveMakerPointPatchVectorField(), waveMakerPointPatchVectorField(), waveMakerPointPatchVectorField(), waveMakerPointPatchVectorField(), and write().

◆ waveAngle_

scalar waveAngle_

Wave angle.

Definition at line 215 of file waveMakerPointPatchVectorField.H.

Referenced by updateCoeffs(), waveMakerPointPatchVectorField(), waveMakerPointPatchVectorField(), waveMakerPointPatchVectorField(), waveMakerPointPatchVectorField(), and write().

◆ waveLength_

scalar waveLength_

Wave length.

Definition at line 220 of file waveMakerPointPatchVectorField.H.

Referenced by updateCoeffs().

◆ startTime_

scalar startTime_

Start time.

Definition at line 225 of file waveMakerPointPatchVectorField.H.

Referenced by updateCoeffs(), waveMakerPointPatchVectorField(), waveMakerPointPatchVectorField(), waveMakerPointPatchVectorField(), waveMakerPointPatchVectorField(), and write().

◆ rampTime_

scalar rampTime_

Ramp time.

Definition at line 230 of file waveMakerPointPatchVectorField.H.

Referenced by timeCoeff(), waveMakerPointPatchVectorField(), waveMakerPointPatchVectorField(), waveMakerPointPatchVectorField(), waveMakerPointPatchVectorField(), and write().

◆ secondOrder_

scalar secondOrder_

On/off second order calculation switch.

Definition at line 235 of file waveMakerPointPatchVectorField.H.

Referenced by updateCoeffs(), waveMakerPointPatchVectorField(), waveMakerPointPatchVectorField(), waveMakerPointPatchVectorField(), waveMakerPointPatchVectorField(), and write().

◆ nPaddle_

label nPaddle_

Number of wave paddles.

Definition at line 240 of file waveMakerPointPatchVectorField.H.

Referenced by initialiseGeometry(), updateCoeffs(), waveMakerPointPatchVectorField(), waveMakerPointPatchVectorField(), waveMakerPointPatchVectorField(), waveMakerPointPatchVectorField(), and write().

◆ Rgl_

tensor Rgl_

Rotation tensor from global to local system.

Definition at line 245 of file waveMakerPointPatchVectorField.H.

◆ Rlg_

tensor Rlg_

Rotation tensor from local to global system.

Definition at line 250 of file waveMakerPointPatchVectorField.H.

◆ xPaddle_

scalarField xPaddle_

Paddle x co-ordinates / [m].

Definition at line 255 of file waveMakerPointPatchVectorField.H.

Referenced by initialiseGeometry(), and updateCoeffs().

◆ yPaddle_

scalarField yPaddle_

Paddle y co-ordinates / [m].

Definition at line 260 of file waveMakerPointPatchVectorField.H.

Referenced by initialiseGeometry(), and updateCoeffs().

◆ pointToPaddle_

labelList pointToPaddle_

Addressing from point patch index to paddle index.

Definition at line 265 of file waveMakerPointPatchVectorField.H.

Referenced by initialiseGeometry(), and updateCoeffs().

◆ faceToPaddle_

labelList faceToPaddle_

Addressing from patch face index to paddle index.

Definition at line 270 of file waveMakerPointPatchVectorField.H.

◆ x_

scalarField x_

Patch face centre x co-ordinates / [m].

Definition at line 275 of file waveMakerPointPatchVectorField.H.

Referenced by initialiseGeometry().

◆ y_

scalarField y_

Patch face centre y co-ordinates / [m].

Definition at line 280 of file waveMakerPointPatchVectorField.H.

Referenced by initialiseGeometry().

◆ z_

scalarField z_

Patch face centre z co-ordinates / [m].

Definition at line 285 of file waveMakerPointPatchVectorField.H.

Referenced by initialiseGeometry().

◆ zSpan_

scalar zSpan_

Overall (point) span in z-direction / [m].

Definition at line 290 of file waveMakerPointPatchVectorField.H.

Referenced by initialiseGeometry().

◆ zMin_

scalarField zMin_

Minimum z (point) height per patch face / [m].

Definition at line 295 of file waveMakerPointPatchVectorField.H.

◆ zMinGb_

scalar zMinGb_

Global Minimum z (point) / [m].

Definition at line 300 of file waveMakerPointPatchVectorField.H.

Referenced by initialiseGeometry(), and updateCoeffs().

◆ zMax_

scalarField zMax_

Maximum z (point) height per patch face / [m].

Definition at line 305 of file waveMakerPointPatchVectorField.H.

◆ waterDepthRef_

scalarField waterDepthRef_

Calculated water depth at the patch.

Definition at line 310 of file waveMakerPointPatchVectorField.H.

Referenced by updateCoeffs(), and waveMakerPointPatchVectorField().

◆ firstTime

scalar firstTime = 0

Definition at line 313 of file waveMakerPointPatchVectorField.H.

Referenced by updateCoeffs().

The documentation for this class was generated from the following files:

src/waveModels/derivedPointPatchFields/waveMaker/waveMakerPointPatchVectorField.H
src/waveModels/derivedPointPatchFields/waveMaker/waveMakerPointPatchVectorField.C

Public Types

Public Member Functions

Public Attributes

Static Public Attributes

Additional Inherited Members

Detailed Description

Member Enumeration Documentation

◆ motionTypes

Constructor & Destructor Documentation

◆ waveMakerPointPatchVectorField() [1/4]

◆ waveMakerPointPatchVectorField() [2/4]

◆ waveMakerPointPatchVectorField() [3/4]

◆ waveMakerPointPatchVectorField() [4/4]

Member Function Documentation

◆ g()

◆ waveLength()

◆ timeCoeff()

◆ initialiseGeometry()

◆ TypeName()

◆ clone() [1/2]

◆ clone() [2/2]

◆ updateCoeffs()

◆ write()

Member Data Documentation

◆ motionTypeNames

◆ motionType_

◆ n_

◆ gHat_

◆ initialDepth_

◆ wavePeriod_

◆ waveHeight_

◆ wavePhase_

◆ waveAngle_

◆ waveLength_

◆ startTime_

◆ rampTime_

◆ secondOrder_

◆ nPaddle_

◆ Rgl_

◆ Rlg_

◆ xPaddle_

◆ yPaddle_

◆ pointToPaddle_

◆ faceToPaddle_

◆ x_

◆ y_

◆ z_

◆ zSpan_

◆ zMin_

◆ zMinGb_

◆ zMax_

◆ waterDepthRef_

◆ firstTime