Public Member Functions | List of all members
waveVelocityFvPatchVectorField Class Reference

This boundary condition provides a waveVelocity condition. This sets the velocity to that specified by a superposition of wave models. All the wave modelling parameters are obtained from a centrally registered waveSuperposition class. More...

Inheritance diagram for waveVelocityFvPatchVectorField:
Inheritance graph
[legend]
Collaboration diagram for waveVelocityFvPatchVectorField:
Collaboration graph
[legend]

Public Member Functions

 TypeName ("waveVelocity")
 Runtime type information. More...
 
 waveVelocityFvPatchVectorField (const fvPatch &, const DimensionedField< vector, fvMesh > &, const dictionary &)
 Construct from patch, internal field and dictionary. More...
 
 waveVelocityFvPatchVectorField (const waveVelocityFvPatchVectorField &, const fvPatch &, const DimensionedField< vector, fvMesh > &, const fieldMapper &)
 Construct by mapping given mixedTypeFvPatchField onto a new patch. More...
 
 waveVelocityFvPatchVectorField (const waveVelocityFvPatchVectorField &)=delete
 Disallow copy without setting internal field reference. More...
 
 waveVelocityFvPatchVectorField (const waveVelocityFvPatchVectorField &, const DimensionedField< vector, fvMesh > &)
 Copy constructor setting internal field reference. More...
 
virtual tmp< fvPatchVectorField > clone (const DimensionedField< vector, fvMesh > &iF) const
 Construct and return a clone setting internal field reference. More...
 
const fvMeshSubset & faceCellSubset () const
 Access the face-cell subset. More...
 
tmp< vectorField > U (const scalar t) const
 Return the current modelled velocity field on the patch faces. More...
 
tmp< vectorField > Un (const scalar t) const
 Return the current modelled velocity field in the neighbour. More...
 
virtual void updateCoeffs ()
 Update the coefficients associated with the patch field. More...
 

Detailed Description

This boundary condition provides a waveVelocity condition. This sets the velocity to that specified by a superposition of wave models. All the wave modelling parameters are obtained from a centrally registered waveSuperposition class.

Usage
Property Description Required? Default
phi Name of the flux field no phi

Example of the boundary condition specification: 

    <patchName>
    {
        type        waveVelocity;
        libs        ("libwaves.so");
    }
See also
Foam::waveSuperposition
Source files

Definition at line 82 of file waveVelocityFvPatchVectorField.H.

Constructor & Destructor Documentation

◆ waveVelocityFvPatchVectorField() [1/4]

waveVelocityFvPatchVectorField ( const fvPatch &  p,
const DimensionedField< vector, fvMesh > &  iF,
const dictionary &  dict 
)

Construct from patch, internal field and dictionary.

Definition at line 34 of file waveVelocityFvPatchVectorField.C.

References dict, DimensionedField< Type, GeoMesh, PrimitiveField >::dimensions(), and p.

Referenced by waveVelocityFvPatchVectorField::clone().

Here is the call graph for this function:
Here is the caller graph for this function:

◆ waveVelocityFvPatchVectorField() [2/4]

waveVelocityFvPatchVectorField ( const waveVelocityFvPatchVectorField &  ptf,
const fvPatch &  p,
const DimensionedField< vector, fvMesh > &  iF,
const fieldMapper &  mapper 
)

Construct by mapping given mixedTypeFvPatchField onto a new patch.

Definition at line 60 of file waveVelocityFvPatchVectorField.C.

◆ waveVelocityFvPatchVectorField() [3/4]

waveVelocityFvPatchVectorField ( const waveVelocityFvPatchVectorField &  )
delete

Disallow copy without setting internal field reference.

◆ waveVelocityFvPatchVectorField() [4/4]

waveVelocityFvPatchVectorField ( const waveVelocityFvPatchVectorField &  ptf,
const DimensionedField< vector, fvMesh > &  iF 
)

Copy constructor setting internal field reference.

Definition at line 72 of file waveVelocityFvPatchVectorField.C.

Member Function Documentation

◆ TypeName()

TypeName ( "waveVelocity"  )

Runtime type information.

◆ clone()

virtual tmp<fvPatchVectorField> clone ( const DimensionedField< vector, fvMesh > &  iF) const
inlinevirtual

Construct and return a clone setting internal field reference.

Definition at line 134 of file waveVelocityFvPatchVectorField.H.

References waveVelocityFvPatchVectorField::waveVelocityFvPatchVectorField().

Here is the call graph for this function:

◆ faceCellSubset()

const Foam::fvMeshSubset & faceCellSubset ( ) const

Access the face-cell subset.

Definition at line 85 of file waveVelocityFvPatchVectorField.C.

References polyMesh::changing(), mesh, fvMesh::time(), timeIndex, and TimeState::timeIndex().

Here is the call graph for this function:

◆ U()

Foam::tmp< Foam::vectorField > U ( const scalar  t) const

Return the current modelled velocity field on the patch faces.

at the given time

Definition at line 111 of file waveVelocityFvPatchVectorField.C.

References waveSuperposition::height(), Foam::levelSetAverage(), waveSuperposition::New(), waveSuperposition::UGas(), and waveSuperposition::ULiquid().

Here is the call graph for this function:

◆ Un()

Foam::tmp< Foam::vectorField > Un ( const scalar  t) const

Return the current modelled velocity field in the neighbour.

cells at the given time

Definition at line 130 of file waveVelocityFvPatchVectorField.C.

References fvMesh::boundary(), primitiveMesh::cellCentres(), f(), Foam::findIndex(), forAll, waveSuperposition::height(), Foam::levelSetAverage(), waveSuperposition::New(), polyMesh::points(), tmp< T >::ref(), Foam::subset(), waveSuperposition::UGas(), and waveSuperposition::ULiquid().

Here is the call graph for this function:

◆ updateCoeffs()

void updateCoeffs ( )
virtual

Update the coefficients associated with the patch field.

Definition at line 171 of file waveVelocityFvPatchVectorField.C.

References Foam::operator==(), Foam::dimensions::time, and U.

Here is the call graph for this function:
The documentation for this class was generated from the following files: