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

Inheritance diagram for waveMakerPointPatchVectorField:

Collaboration diagram for waveMakerPointPatchVectorField:

Public Types
enum	motionTypes { piston, flap, solitary }

Public Types inherited from pointPatchField< vector >
typedef vector	value_type

typedef pointPatch	Patch

typedef calculatedPointPatchField< vector >	Calculated

Public Types inherited from Field< vector >
typedef pTraits< vector >::cmptType	cmptType
	Component type. More...

typedef SubField< vector >	subField
	Declare type of subField. 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 >
	TypeName ("pointPatchField")
	Runtime type information. More...

	declareRunTimeSelectionTable (autoPtr, pointPatchField, pointPatch,(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...

const objectRegistry &	db () const
	Return local objectRegistry. More...

label	size () const
	Return size. More...

const pointPatch &	patch () const
	Return patch. More...

const DimensionedField< vector, pointMesh > &	internalField () const
	Return dimensioned internal field reference. More...

const Field< vector > &	primitiveField () const
	Return internal field reference. More...

const word &	patchType () const
	Optional patch type. More...

word &	patchType ()
	Optional patch type. More...

virtual bool	coupled () const
	Return true if this patch field is coupled. More...

bool	updated () const
	Return true if the boundary condition has already been updated. 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 const word &	constraintType () const
	Return the constraint type this pointPatchField implements. 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. 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)

	Field (const tmp< Field< vector >> &tmapF, const FieldMapper &map, const UList< vector > &defaultValues, const bool applyFlip=true)

	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 word &keyword, const dictionary &dict, const label len)
	Construct from a dictionary entry. More...

tmp< Field< vector > >	clone () const
	Clone. 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 ()
	Negate this field (negative). 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 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 pointPatchField< vector >
static int	disallowGenericPointPatchField
	Debug switch to disallow the use of genericPointPatchField. More...

Additional Inherited Members
Static Public Member Functions inherited from pointPatchField< vector >
static autoPtr< pointPatchField< vector > >	New (const word &, const pointPatch &, const DimensionedField< vector, pointMesh > &)
	Return a pointer to a new patchField created on freestore given. More...

static autoPtr< pointPatchField< vector > >	New (const word &, const word &actualPatchType, const pointPatch &, const DimensionedField< vector, pointMesh > &)
	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 ()
	Return the type of the calculated form of pointPatchField. 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)

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 157 of file waveMakerPointPatchVectorField.H.

Member Enumeration Documentation

◆ motionTypes

enum motionTypes

Enumerator
piston
flap
solitary

Definition at line 163 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 141 of file waveMakerPointPatchVectorField.C.

Referenced by waveMakerPointPatchVectorField::clone().

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 163 of file waveMakerPointPatchVectorField.C.

References dict, Foam::exit(), Foam::FatalIOError, FatalIOErrorInFunction, dictionary::found(), g, Foam::mag(), and Foam::constant::mathematical::pi().

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 patchField<vector> onto a new patch.

Definition at line 223 of file waveMakerPointPatchVectorField.C.

◆ waveMakerPointPatchVectorField() [4/4]

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

Construct as copy setting internal field reference.

Definition at line 247 of file waveMakerPointPatchVectorField.C.

Member Function Documentation

◆ g()

const Foam::vector & g ( )

Return the gravitational acceleration.

Definition at line 53 of file waveMakerPointPatchVectorField.C.

References pointPatchField< vector >::db(), Foam::exit(), Foam::FatalError, FatalErrorInFunction, Foam::mag(), gravity::New(), and dimensioned< Type >::value().

Here is the call graph for this function:

◆ waveLength()

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

virtual

Dispersion equation.

Definition at line 70 of file waveMakerPointPatchVectorField.C.

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

Here is the call graph for this function:

◆ timeCoeff()

Foam::scalar timeCoeff ( const scalar t ) const

virtual

Return the time scaling coefficient.

Definition at line 88 of file waveMakerPointPatchVectorField.C.

References Foam::max(), and Foam::min().

Here is the call graph for this function:

◆ initialiseGeometry()

void initialiseGeometry ( )

virtual

Initialise.

Definition at line 96 of file waveMakerPointPatchVectorField.C.

References Cp, forAll, boundBox::max(), boundBox::min(), Foam::foamVersion::patch, Foam::reduce(), Vector< Cmpt >::x(), xMax, xMin, Vector< Cmpt >::y(), and Vector< Cmpt >::z().

Here is the call graph for this function:

◆ TypeName()

TypeName ( "waveMaker" )

Runtime type information.

◆ clone() [1/2]

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

inlinevirtual

Construct and return a clone.

Reimplemented from fixedValuePointPatchField< vector >.

Definition at line 311 of file waveMakerPointPatchVectorField.H.

References waveMakerPointPatchVectorField::waveMakerPointPatchVectorField().

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.

Reimplemented from fixedValuePointPatchField< vector >.

Definition at line 331 of file waveMakerPointPatchVectorField.H.

References waveMakerPointPatchVectorField::waveMakerPointPatchVectorField().

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

Here is the call graph for this function:

◆ write()

void write ( Ostream & os ) const

virtual

Write.

Reimplemented from valuePointPatchField< vector >.

Definition at line 449 of file waveMakerPointPatchVectorField.C.

References os(), pointPatchField< Type >::write(), and Ostream::writeEntry().

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 171 of file waveMakerPointPatchVectorField.H.

◆ motionType_

motionTypes motionType_

Motion type.

Definition at line 177 of file waveMakerPointPatchVectorField.H.

◆ 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 182 of file waveMakerPointPatchVectorField.H.

◆ gHat_

vector gHat_

Vertical direction.

Definition at line 185 of file waveMakerPointPatchVectorField.H.

◆ initialDepth_

scalar initialDepth_

Initial water depth.

Definition at line 188 of file waveMakerPointPatchVectorField.H.

◆ wavePeriod_

scalar wavePeriod_

Wave period.

Definition at line 191 of file waveMakerPointPatchVectorField.H.

◆ waveHeight_

scalar waveHeight_

Wave height.

Definition at line 194 of file waveMakerPointPatchVectorField.H.

◆ wavePhase_

scalar wavePhase_

Wave phase.

Definition at line 197 of file waveMakerPointPatchVectorField.H.

◆ waveAngle_

scalar waveAngle_

Wave angle.

Definition at line 200 of file waveMakerPointPatchVectorField.H.

◆ waveLength_

scalar waveLength_

Wave length.

Definition at line 203 of file waveMakerPointPatchVectorField.H.

◆ startTime_

scalar startTime_

Start time.

Definition at line 206 of file waveMakerPointPatchVectorField.H.

◆ rampTime_

scalar rampTime_

Ramp time.

Definition at line 209 of file waveMakerPointPatchVectorField.H.

◆ secondOrder_

scalar secondOrder_

On/off second order calculation switch.

Definition at line 212 of file waveMakerPointPatchVectorField.H.

◆ nPaddle_

label nPaddle_

Number of wave paddles.

Definition at line 215 of file waveMakerPointPatchVectorField.H.

◆ Rgl_

tensor Rgl_

Rotation tensor from global to local system.

Definition at line 218 of file waveMakerPointPatchVectorField.H.

◆ Rlg_

tensor Rlg_

Rotation tensor from local to global system.

Definition at line 221 of file waveMakerPointPatchVectorField.H.

◆ xPaddle_

scalarField xPaddle_

Paddle x co-ordinates / [m].

Definition at line 224 of file waveMakerPointPatchVectorField.H.

◆ yPaddle_

scalarField yPaddle_

Paddle y co-ordinates / [m].

Definition at line 227 of file waveMakerPointPatchVectorField.H.

◆ pointToPaddle_

labelList pointToPaddle_

Addressing from point patch index to paddle index.

Definition at line 230 of file waveMakerPointPatchVectorField.H.

◆ faceToPaddle_

labelList faceToPaddle_

Addressing from patch face index to paddle index.

Definition at line 233 of file waveMakerPointPatchVectorField.H.

◆ x_

scalarField x_

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

Definition at line 236 of file waveMakerPointPatchVectorField.H.

◆ y_

scalarField y_

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

Definition at line 239 of file waveMakerPointPatchVectorField.H.

◆ z_

scalarField z_

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

Definition at line 242 of file waveMakerPointPatchVectorField.H.

◆ zSpan_

scalar zSpan_

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

Definition at line 245 of file waveMakerPointPatchVectorField.H.

◆ zMin_

scalarField zMin_

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

Definition at line 248 of file waveMakerPointPatchVectorField.H.

◆ zMinGb_

scalar zMinGb_

Global Minimum z (point) / [m].

Definition at line 251 of file waveMakerPointPatchVectorField.H.

◆ zMax_

scalarField zMax_

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

Definition at line 254 of file waveMakerPointPatchVectorField.H.

◆ waterDepthRef_

scalarField waterDepthRef_

Calculated water depth at the patch.

Definition at line 257 of file waveMakerPointPatchVectorField.H.

◆ firstTime

scalar firstTime = 0

Definition at line 260 of file waveMakerPointPatchVectorField.H.

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