Public Types | Public Member Functions | List of all members
waveSurfacePressureFvPatchScalarField Class Reference

This is a pressure boundary condition, the value of which is calculated as the hydrostatic pressure based on a given displacement: More...

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

Public Types

enum  ddtSchemeType { tsEuler , tsCrankNicolson , tsBackward }
 Enumeration defining the available ddt schemes. More...
 

Public Member Functions

 TypeName ("waveSurfacePressure")
 Runtime type information. More...
 
 waveSurfacePressureFvPatchScalarField (const fvPatch &, const DimensionedField< scalar, volMesh > &, const dictionary &)
 Construct from patch, internal field and dictionary. More...
 
 waveSurfacePressureFvPatchScalarField (const waveSurfacePressureFvPatchScalarField &, const fvPatch &, const DimensionedField< scalar, volMesh > &, const fieldMapper &)
 Construct by mapping given waveSurfacePressureFvPatchScalarField. More...
 
 waveSurfacePressureFvPatchScalarField (const waveSurfacePressureFvPatchScalarField &)=delete
 Disallow copy without setting internal field reference. More...
 
 waveSurfacePressureFvPatchScalarField (const waveSurfacePressureFvPatchScalarField &, const DimensionedField< scalar, volMesh > &)
 Copy constructor setting internal field reference. More...
 
virtual tmp< fvPatchScalarField > clone (const DimensionedField< scalar, volMesh > &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...
 

Detailed Description

This is a pressure boundary condition, the value of which is calculated as the hydrostatic pressure based on a given displacement:

\[ p_rgh = -\rho*g*\zeta \]

$ \rho $ = density [kg/m^3]
$ g $ = acceleration due to gravity [m/s^2]
$ \zeta $ = wave amplitude [m]

The wave amplitude is updated as part of the calculation, derived from the local volumetric flux.

Usage
Property Description Required Default value
phi flux field name no phi
rho density field name no rho
zeta wave amplitude field name no zeta

Example of the boundary condition specification: 

    <patchName>
    {
        type            waveSurfacePressure;
        phi             phi;
        rho             rho;
        zeta            zeta;
        value           uniform 0;  // Initial value
    }

The density field is only required if the flux is mass-based as opposed to volumetric-based.

See also
Foam::fixedValueFvPatchField
Source files

Definition at line 121 of file waveSurfacePressureFvPatchScalarField.H.

Member Enumeration Documentation

◆ ddtSchemeType

enum ddtSchemeType

Enumeration defining the available ddt schemes.

Enumerator
tsEuler 
tsCrankNicolson 
tsBackward 

Definition at line 130 of file waveSurfacePressureFvPatchScalarField.H.

Constructor & Destructor Documentation

◆ waveSurfacePressureFvPatchScalarField() [1/4]

waveSurfacePressureFvPatchScalarField ( const fvPatch &  p,
const DimensionedField< scalar, volMesh > &  iF,
const dictionary &  dict 
)

Construct from patch, internal field and dictionary.

Definition at line 53 of file waveSurfacePressureFvPatchScalarField.C.

References IOobject::AUTO_WRITE, Foam::dimLength, Foam::endl(), Foam::Info, mesh, Foam::name(), tmp< T >::ptr(), IOobject::READ_IF_PRESENT, regIOobject::store(), and Foam::Zero.

Referenced by waveSurfacePressureFvPatchScalarField::clone().

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

◆ waveSurfacePressureFvPatchScalarField() [2/4]

waveSurfacePressureFvPatchScalarField ( const waveSurfacePressureFvPatchScalarField &  ptf,
const fvPatch &  p,
const DimensionedField< scalar, volMesh > &  iF,
const fieldMapper &  mapper 
)

Construct by mapping given waveSurfacePressureFvPatchScalarField.

onto a new patch

Definition at line 92 of file waveSurfacePressureFvPatchScalarField.C.

◆ waveSurfacePressureFvPatchScalarField() [3/4]

waveSurfacePressureFvPatchScalarField ( const waveSurfacePressureFvPatchScalarField &  )
delete

Disallow copy without setting internal field reference.

◆ waveSurfacePressureFvPatchScalarField() [4/4]

waveSurfacePressureFvPatchScalarField ( const waveSurfacePressureFvPatchScalarField &  wspsf,
const DimensionedField< scalar, volMesh > &  iF 
)

Copy constructor setting internal field reference.

Definition at line 108 of file waveSurfacePressureFvPatchScalarField.C.

Member Function Documentation

◆ TypeName()

TypeName ( "waveSurfacePressure"  )

Runtime type information.

◆ clone()

virtual tmp<fvPatchScalarField> clone ( const DimensionedField< scalar, volMesh > &  iF) const
inlinevirtual

Construct and return a clone setting internal field reference.

Definition at line 195 of file waveSurfacePressureFvPatchScalarField.H.

References waveSurfacePressureFvPatchScalarField::waveSurfacePressureFvPatchScalarField().

Here is the call graph for this function:

◆ updateCoeffs()

void updateCoeffs ( )
virtual

Update the coefficients associated with the patch field.

Definition at line 124 of file waveSurfacePressureFvPatchScalarField.C.

References Foam::abort(), GeometricField< Type, GeoMesh, PrimitiveField >::boundaryField(), GeometricField< Type, GeoMesh, PrimitiveField >::boundaryFieldRef(), Foam::constant::universal::c, DimensionedField< Type, GeoMesh, PrimitiveField >::dimensions(), Foam::dimMassFlux, Foam::FatalError, FatalErrorInFunction, DimensionedField< Type, GeoMesh, PrimitiveField >::mesh(), IOobject::name(), Foam::nl, OldTimeField< FieldType >::oldTime(), Foam::operator==(), patchi, and UniformDimensionedField< Type >::value().

Here is the call graph for this function:

◆ write()

void write ( Ostream &  os) const
virtual

Write.

Definition at line 211 of file waveSurfacePressureFvPatchScalarField.C.

References fvPatchField< Type >::write(), and Foam::writeEntry().

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