This is a pressure boundary condition, whose value is calculated as the hydrostatic pressure based on a given displacement: More...
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 > &) | |
Construct from patch and internal field. 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 fvPatchFieldMapper &) | |
Construct by mapping given waveSurfacePressureFvPatchScalarField. More... | |
waveSurfacePressureFvPatchScalarField (const waveSurfacePressureFvPatchScalarField &) | |
Construct as copy. More... | |
virtual tmp< fvPatchScalarField > | clone () const |
Construct and return a clone. More... | |
waveSurfacePressureFvPatchScalarField (const waveSurfacePressureFvPatchScalarField &, const DimensionedField< scalar, volMesh > &) | |
Construct as copy 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... | |
This is a pressure boundary condition, whose value is calculated as the hydrostatic pressure based on a given displacement:
= | density [kg/m3] | |
= | acceleration due to gravity [m/s2] | |
= | wave amplitude [m] |
The wave amplitude is updated as part of the calculation, derived from the local volumetric flux.
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; // place holder }
The density field is only required if the flux is mass-based as opposed to volumetric-based.
Definition at line 124 of file waveSurfacePressureFvPatchScalarField.H.
enum ddtSchemeType |
Enumeration defining the available ddt schemes.
Enumerator | |
---|---|
tsEuler | |
tsCrankNicolson | |
tsBackward |
Definition at line 133 of file waveSurfacePressureFvPatchScalarField.H.
waveSurfacePressureFvPatchScalarField | ( | const fvPatch & | p, |
const DimensionedField< scalar, volMesh > & | iF | ||
) |
Construct from patch and internal field.
Definition at line 65 of file waveSurfacePressureFvPatchScalarField.C.
Referenced by waveSurfacePressureFvPatchScalarField::clone(), NamedEnum< directionType, 3 >::names(), and waveSurfacePressureFvPatchScalarField::waveSurfacePressureFvPatchScalarField().
waveSurfacePressureFvPatchScalarField | ( | const fvPatch & | p, |
const DimensionedField< scalar, volMesh > & | iF, | ||
const dictionary & | dict | ||
) |
Construct from patch, internal field and dictionary.
Definition at line 79 of file waveSurfacePressureFvPatchScalarField.C.
References waveSurfacePressureFvPatchScalarField::waveSurfacePressureFvPatchScalarField().
waveSurfacePressureFvPatchScalarField | ( | const waveSurfacePressureFvPatchScalarField & | ptf, |
const fvPatch & | p, | ||
const DimensionedField< scalar, volMesh > & | iF, | ||
const fvPatchFieldMapper & | mapper | ||
) |
Construct by mapping given waveSurfacePressureFvPatchScalarField.
onto a new patch
Definition at line 94 of file waveSurfacePressureFvPatchScalarField.C.
References waveSurfacePressureFvPatchScalarField::waveSurfacePressureFvPatchScalarField().
Construct as copy.
Definition at line 110 of file waveSurfacePressureFvPatchScalarField.C.
References waveSurfacePressureFvPatchScalarField::waveSurfacePressureFvPatchScalarField().
waveSurfacePressureFvPatchScalarField | ( | const waveSurfacePressureFvPatchScalarField & | wspsf, |
const DimensionedField< scalar, volMesh > & | iF | ||
) |
Construct as copy setting internal field reference.
Definition at line 123 of file waveSurfacePressureFvPatchScalarField.C.
TypeName | ( | "waveSurfacePressure" | ) |
Runtime type information.
|
inlinevirtual |
Construct and return a clone.
Definition at line 198 of file waveSurfacePressureFvPatchScalarField.H.
References waveSurfacePressureFvPatchScalarField::waveSurfacePressureFvPatchScalarField().
|
inlinevirtual |
Construct and return a clone setting internal field reference.
Definition at line 215 of file waveSurfacePressureFvPatchScalarField.H.
References waveSurfacePressureFvPatchScalarField::updateCoeffs(), waveSurfacePressureFvPatchScalarField::waveSurfacePressureFvPatchScalarField(), and waveSurfacePressureFvPatchScalarField::write().
|
virtual |
Update the coefficients associated with the patch field.
Definition at line 137 of file waveSurfacePressureFvPatchScalarField.C.
References Foam::abort(), GeometricField< Type, PatchField, GeoMesh >::boundaryField(), GeometricField< Type, PatchField, GeoMesh >::boundaryFieldRef(), Foam::constant::universal::c, Foam::dimArea, Foam::dimDensity, DimensionedField< Type, GeoMesh >::dimensions(), Foam::dimVelocity, Foam::endl(), Foam::FatalError, FatalErrorInFunction, g, Foam::gMax(), Foam::gMin(), Foam::Info, DimensionedField< Type, GeoMesh >::mesh(), IOobject::name(), Foam::nl, GeometricField< Type, PatchField, GeoMesh >::oldTime(), Foam::operator==(), patchi, phi, and dimensioned< Type >::value().
Referenced by waveSurfacePressureFvPatchScalarField::clone().
|
virtual |
Write.
Definition at line 227 of file waveSurfacePressureFvPatchScalarField.C.
References Foam::makePatchTypeField(), and fvPatchField< Type >::write().
Referenced by waveSurfacePressureFvPatchScalarField::clone().