Public Member Functions | Protected Attributes | List of all members
freeSurfacePressureFvPatchScalarField Class Reference
Boundary conditions » Generic

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

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

Public Member Functions

 TypeName ("freeSurfacePressure")
 
 freeSurfacePressureFvPatchScalarField (const fvPatch &, const DimensionedField< scalar, volMesh > &)
 
 freeSurfacePressureFvPatchScalarField (const fvPatch &, const DimensionedField< scalar, volMesh > &, const dictionary &)
 
 freeSurfacePressureFvPatchScalarField (const freeSurfacePressureFvPatchScalarField &, const fvPatch &, const DimensionedField< scalar, volMesh > &, const fvPatchFieldMapper &)
 
 freeSurfacePressureFvPatchScalarField (const freeSurfacePressureFvPatchScalarField &)
 
virtual tmp< fvPatchScalarField > clone () const
 
 freeSurfacePressureFvPatchScalarField (const freeSurfacePressureFvPatchScalarField &, const DimensionedField< scalar, volMesh > &)
 
virtual tmp< fvPatchScalarField > clone (const DimensionedField< scalar, volMesh > &iF) const
 
const scalarField & pa () const
 
scalarField & pa ()
 
virtual void autoMap (const fvPatchFieldMapper &)
 
virtual void rmap (const fvPatchScalarField &, const labelList &)
 
virtual void updateCoeffs ()
 
virtual void write (Ostream &) const
 

Protected Attributes

scalarField pa_
 

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 
)

Definition at line 34 of file freeSurfacePressureFvPatchScalarField.C.

Referenced by freeSurfacePressureFvPatchScalarField::clone().

Here is the caller graph for this function:

◆ freeSurfacePressureFvPatchScalarField() [2/5]

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

Definition at line 46 of file freeSurfacePressureFvPatchScalarField.C.

References dict, dictionary::found(), and p.

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 
)

Definition at line 71 of file freeSurfacePressureFvPatchScalarField.C.

◆ freeSurfacePressureFvPatchScalarField() [4/5]

freeSurfacePressureFvPatchScalarField ( const freeSurfacePressureFvPatchScalarField &  ptf)

Definition at line 85 of file freeSurfacePressureFvPatchScalarField.C.

◆ freeSurfacePressureFvPatchScalarField() [5/5]

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

Definition at line 96 of file freeSurfacePressureFvPatchScalarField.C.

Member Function Documentation

◆ TypeName()

TypeName ( "freeSurfacePressure"  )

◆ clone() [1/2]

virtual tmp<fvPatchScalarField> clone ( ) const
inlinevirtual

Definition at line 153 of file freeSurfacePressureFvPatchScalarField.H.

References freeSurfacePressureFvPatchScalarField::freeSurfacePressureFvPatchScalarField().

Here is the call graph for this function:

◆ clone() [2/2]

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

Definition at line 170 of file freeSurfacePressureFvPatchScalarField.H.

References freeSurfacePressureFvPatchScalarField::freeSurfacePressureFvPatchScalarField().

Here is the call graph for this function:

◆ pa() [1/2]

const scalarField& pa ( ) const
inline

Definition at line 186 of file freeSurfacePressureFvPatchScalarField.H.

References freeSurfacePressureFvPatchScalarField::pa_.

◆ pa() [2/2]

scalarField& pa ( )
inline

Definition at line 192 of file freeSurfacePressureFvPatchScalarField.H.

References freeSurfacePressureFvPatchScalarField::pa_.

◆ autoMap()

void autoMap ( const fvPatchFieldMapper &  m)
virtual

Definition at line 109 of file freeSurfacePressureFvPatchScalarField.C.

◆ rmap()

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

Definition at line 119 of file freeSurfacePressureFvPatchScalarField.C.

References freeSurfacePressureFvPatchScalarField::pa_.

◆ updateCoeffs()

void updateCoeffs ( )
virtual

Definition at line 133 of file freeSurfacePressureFvPatchScalarField.C.

References interfaceTrackingFvMesh::freeSurfacePressureJump(), objectRegistry::lookupObject(), mesh, freeSurfacePressureFvPatchScalarField::pa_, and Foam::foamVersion::patch.

Here is the call graph for this function:

◆ write()

void write ( Ostream &  os) const
virtual

Definition at line 160 of file freeSurfacePressureFvPatchScalarField.C.

References os(), and fvPatchField::write().

Here is the call graph for this function:

Member Data Documentation

◆ pa_

scalarField pa_
protected

Definition at line 111 of file freeSurfacePressureFvPatchScalarField.H.

Referenced by freeSurfacePressureFvPatchScalarField::pa(), freeSurfacePressureFvPatchScalarField::rmap(), and freeSurfacePressureFvPatchScalarField::updateCoeffs().

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

Copyright © 2011-2018  OpenFOAM | OPENFOAM® is a registered trademark of OpenCFD Ltd.

Generated by   doxygen 1.8.17