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

Inheritance diagram for waveSurfacePressureFvPatchScalarField:

[legend]

Collaboration diagram for waveSurfacePressureFvPatchScalarField:

[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 > &)
	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...

Detailed Description

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

$p = -\rho*g*\zeta$

$\rho$	=	density [kg/m3]
	=	acceleration due to gravity [m/s2]
$\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;  // place holder
    }

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 124 of file waveSurfacePressureFvPatchScalarField.H.

Member Enumeration Documentation

enum ddtSchemeType

Enumeration defining the available ddt schemes.

Enumerator
tsEuler
tsCrankNicolson
tsBackward

Definition at line 133 of file waveSurfacePressureFvPatchScalarField.H.

Constructor & Destructor Documentation

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< Enum, nEnum >::names(), and waveSurfacePressureFvPatchScalarField::waveSurfacePressureFvPatchScalarField().

Here is the caller graph for this function:

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 fvPatch::size(), and waveSurfacePressureFvPatchScalarField::waveSurfacePressureFvPatchScalarField().

Here is the call graph for this function:

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 99 of file waveSurfacePressureFvPatchScalarField.C.

References waveSurfacePressureFvPatchScalarField::waveSurfacePressureFvPatchScalarField().

Here is the call graph for this function:

waveSurfacePressureFvPatchScalarField ( const waveSurfacePressureFvPatchScalarField & wspsf )

Construct as copy.

Definition at line 115 of file waveSurfacePressureFvPatchScalarField.C.

References waveSurfacePressureFvPatchScalarField::waveSurfacePressureFvPatchScalarField().

Here is the call graph for this function:

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

Construct as copy setting internal field reference.

Definition at line 128 of file waveSurfacePressureFvPatchScalarField.C.

Member Function Documentation

TypeName ( "waveSurfacePressure" )

Runtime type information.

virtual tmp<fvPatchScalarField> clone ( ) const

inlinevirtual

Construct and return a clone.

Definition at line 198 of file waveSurfacePressureFvPatchScalarField.H.

References waveSurfacePressureFvPatchScalarField::waveSurfacePressureFvPatchScalarField().

Here is the call graph for this function:

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

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

Here is the call graph for this function:

void updateCoeffs ( )

virtual

Update the coefficients associated with the patch field.

Definition at line 142 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().

Here is the call graph for this function:

Here is the caller graph for this function:

void write ( Ostream & os ) const

virtual

Write.

Definition at line 236 of file waveSurfacePressureFvPatchScalarField.C.

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

Referenced by waveSurfacePressureFvPatchScalarField::clone().

Here is the call graph for this function:

Here is the caller graph for this function:

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

src/finiteVolume/fields/fvPatchFields/derived/waveSurfacePressure/waveSurfacePressureFvPatchScalarField.H
src/finiteVolume/fields/fvPatchFields/derived/waveSurfacePressure/waveSurfacePressureFvPatchScalarField.C

Public Types

Public Member Functions

Detailed Description

Member Enumeration Documentation

Constructor & Destructor Documentation

Member Function Documentation