Loading...
Searching...
No Matches
freeSurfacePressureFvPatchScalarField Class Reference
Boundary conditions » Generic

This boundary condition provides static pressure condition for p_rgh, calculated as: More...

#include <freeSurfacePressureFvPatchScalarField.H>

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

Public Member Functions

 TypeName ("freeSurfacePressure")
 Runtime type information.
 freeSurfacePressureFvPatchScalarField (const fvPatch &, const DimensionedField< scalar, volMesh > &)
 Construct from patch and internal field.
 freeSurfacePressureFvPatchScalarField (const fvPatch &, const DimensionedField< scalar, volMesh > &, const dictionary &)
 Construct from patch, internal field and dictionary.
 freeSurfacePressureFvPatchScalarField (const freeSurfacePressureFvPatchScalarField &, const fvPatch &, const DimensionedField< scalar, volMesh > &, const fvPatchFieldMapper &)
 Construct by mapping given.
 freeSurfacePressureFvPatchScalarField (const freeSurfacePressureFvPatchScalarField &)
 Construct as copy.
 freeSurfacePressureFvPatchScalarField (const freeSurfacePressureFvPatchScalarField &, const DimensionedField< scalar, volMesh > &)
 Construct as copy setting internal field reference.
virtual tmp< fvPatchField< scalar > > clone () const
 Return a clone.
virtual tmp< fvPatchField< scalar > > clone (const DimensionedField< scalar, volMesh > &iF) const
 Clone with an internal field reference.
const scalarField & pa () const
 Return the ambient pressure.
scalarField & pa ()
 Return reference to the ambient pressure to allow adjustment.
virtual void autoMap (const fvPatchFieldMapper &)
 Map (and resize as needed) from self given a mapping object.
virtual void rmap (const fvPatchScalarField &, const labelList &)
 Reverse map the given fvPatchField onto this fvPatchField.
virtual void updateCoeffs ()
 Update the coefficients associated with the patch field.
virtual void write (Ostream &) const
 Write.

Protected Attributes

scalarField pa_
 Ambient pressure.

Detailed Description

This boundary condition provides static pressure condition for p_rgh, calculated as:

\‍[ p = pa - \vec{g} \cdot \vec{r} \‍]

where

$ p $=Free surface modified pressure
$ pa $=Free surface ambient pressure
$ g $=acceleration due to gravity [m/s^2]
Usage
Property Description Required Default value
pa static ambient pressure yes 0

Example of the boundary condition specification: 

    <patchName>
    {
        type            freeSurfacePressure;
        pa              uniform 0;
        value           uniform 0; // optional initial value
    }
See also
Foam::fixedValueFvPatchScalarField
Source files

Definition at line 102 of file freeSurfacePressureFvPatchScalarField.H.

Constructor & Destructor Documentation

◆ freeSurfacePressureFvPatchScalarField() [1/5]

freeSurfacePressureFvPatchScalarField ( const fvPatch & p,
const DimensionedField< scalar, volMesh > & iF )

Construct from patch and internal field.

Definition at line 32 of file freeSurfacePressureFvPatchScalarField.C.

References p, pa_, and Foam::Zero.

Referenced by freeSurfacePressureFvPatchScalarField(), freeSurfacePressureFvPatchScalarField(), freeSurfacePressureFvPatchScalarField(), rmap(), and TypeName().

Here is the caller graph for this function:

◆ freeSurfacePressureFvPatchScalarField() [2/5]

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

Construct from patch, internal field and dictionary.

Definition at line 44 of file freeSurfacePressureFvPatchScalarField.C.

References dict, fvPatchField< Type >::operator=(), p, and pa_.

Here is the call graph for this function:

◆ freeSurfacePressureFvPatchScalarField() [3/5]

freeSurfacePressureFvPatchScalarField ( const freeSurfacePressureFvPatchScalarField & ptf,
const fvPatch & p,
const DimensionedField< scalar, volMesh > & iF,
const fvPatchFieldMapper & mapper )

Construct by mapping given.

freeSurfacePressureFvPatchScalarField onto a new patch

Definition at line 62 of file freeSurfacePressureFvPatchScalarField.C.

References freeSurfacePressureFvPatchScalarField(), p, and pa_.

Here is the call graph for this function:

◆ freeSurfacePressureFvPatchScalarField() [4/5]

freeSurfacePressureFvPatchScalarField ( const freeSurfacePressureFvPatchScalarField & ptf)

Construct as copy.

Definition at line 76 of file freeSurfacePressureFvPatchScalarField.C.

References freeSurfacePressureFvPatchScalarField(), and pa_.

Here is the call graph for this function:

◆ freeSurfacePressureFvPatchScalarField() [5/5]

freeSurfacePressureFvPatchScalarField ( const freeSurfacePressureFvPatchScalarField & ptf,
const DimensionedField< scalar, volMesh > & iF )

Construct as copy setting internal field reference.

Definition at line 87 of file freeSurfacePressureFvPatchScalarField.C.

References freeSurfacePressureFvPatchScalarField(), and pa_.

Here is the call graph for this function:

Member Function Documentation

◆ TypeName()

TypeName ( "freeSurfacePressure" )

Runtime type information.

References freeSurfacePressureFvPatchScalarField().

Here is the call graph for this function:

◆ clone() [1/2]

virtual tmp< fvPatchField< scalar > > clone ( ) const
inlinevirtual

Return a clone.

Definition at line 177 of file freeSurfacePressureFvPatchScalarField.H.

References fvPatchField< Type >::Clone().

Here is the call graph for this function:

◆ clone() [2/2]

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

Clone with an internal field reference.

Definition at line 185 of file freeSurfacePressureFvPatchScalarField.H.

References fvPatchField< Type >::Clone().

Here is the call graph for this function:

◆ pa() [1/2]

const scalarField & pa ( ) const
inline

Return the ambient pressure.

Definition at line 201 of file freeSurfacePressureFvPatchScalarField.H.

References pa_.

◆ pa() [2/2]

scalarField & pa ( )
inline

Return reference to the ambient pressure to allow adjustment.

Definition at line 209 of file freeSurfacePressureFvPatchScalarField.H.

References pa_.

◆ autoMap()

void autoMap ( const fvPatchFieldMapper & m)
virtual

Map (and resize as needed) from self given a mapping object.

Definition at line 101 of file freeSurfacePressureFvPatchScalarField.C.

References pa_.

◆ rmap()

void rmap ( const fvPatchScalarField & ptf,
const labelList & addr )
virtual

Reverse map the given fvPatchField onto this fvPatchField.

Definition at line 111 of file freeSurfacePressureFvPatchScalarField.C.

References freeSurfacePressureFvPatchScalarField(), pa_, and Foam::refCast().

Here is the call graph for this function:

◆ updateCoeffs()

void updateCoeffs ( )
virtual

Update the coefficients associated with the patch field.

Definition at line 126 of file freeSurfacePressureFvPatchScalarField.C.

References Foam::isA_constCast(), mesh, and pa_.

Here is the call graph for this function:

◆ write()

void write ( Ostream & os) const
virtual

Write.

Definition at line 156 of file freeSurfacePressureFvPatchScalarField.C.

References os(), pa_, fvPatchField< Type >::write(), and fvPatchField< Type >::writeValueEntry().

Here is the call graph for this function:

Member Data Documentation

◆ pa_

scalarField pa_
protected

Ambient pressure.

Definition at line 113 of file freeSurfacePressureFvPatchScalarField.H.

Referenced by autoMap(), freeSurfacePressureFvPatchScalarField(), freeSurfacePressureFvPatchScalarField(), freeSurfacePressureFvPatchScalarField(), freeSurfacePressureFvPatchScalarField(), freeSurfacePressureFvPatchScalarField(), pa(), pa(), rmap(), updateCoeffs(), and write().

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