Public Member Functions | Protected Attributes | List of all members
pressureFvPatchScalarField Class Reference

Static pressure boundary condition. More...

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

Public Member Functions

 TypeName ("pressure")
 Runtime type information. More...
 
 pressureFvPatchScalarField (const fvPatch &, const DimensionedField< scalar, volMesh > &, const dictionary &)
 Construct from patch, internal field and dictionary. More...
 
 pressureFvPatchScalarField (const pressureFvPatchScalarField &, const fvPatch &, const DimensionedField< scalar, volMesh > &, const fieldMapper &)
 Construct by mapping given. More...
 
 pressureFvPatchScalarField (const pressureFvPatchScalarField &)=delete
 Disallow copy without setting internal field reference. More...
 
 pressureFvPatchScalarField (const pressureFvPatchScalarField &, 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...
 
const scalarField & p () const
 Return the static pressure. More...
 
scalarField & p ()
 Return reference to the static pressure to allow adjustment. More...
 
virtual void map (const fvPatchScalarField &, const fieldMapper &)
 Map the given fvPatchField onto this fvPatchField. More...
 
virtual void reset (const fvPatchScalarField &)
 Reset the fvPatchField to the given fvPatchField. More...
 
virtual void updateCoeffs ()
 Update the coefficients associated with the patch field. More...
 
virtual void write (Ostream &) const
 Write. More...
 

Protected Attributes

scalarField p_
 Static pressure. More...
 

Detailed Description

Static pressure boundary condition.

Used as the base-class for static pressure boundary conditions force alternative pressure variables, e.g. p_rgh.

Usage
Property Description Required Default value
p static pressure yes

Example of the boundary condition specification: 

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

Definition at line 81 of file pressureFvPatchScalarField.H.

Constructor & Destructor Documentation

◆ pressureFvPatchScalarField() [1/4]

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

Construct from patch, internal field and dictionary.

Definition at line 34 of file pressureFvPatchScalarField.C.

References dict, DimensionedField< Type, GeoMesh, PrimitiveField >::dimensions(), fvPatchField< Type >::operator, fvPatchField< Type >::operator=(), pressureFvPatchScalarField::p(), pressureFvPatchScalarField::p_, and List< T >::size().

Referenced by pressureFvPatchScalarField::clone().

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

◆ pressureFvPatchScalarField() [2/4]

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

Construct by mapping given.

pressureFvPatchScalarField onto a new patch

Definition at line 58 of file pressureFvPatchScalarField.C.

◆ pressureFvPatchScalarField() [3/4]

pressureFvPatchScalarField ( const pressureFvPatchScalarField &  )
delete

Disallow copy without setting internal field reference.

◆ pressureFvPatchScalarField() [4/4]

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

Copy constructor setting internal field reference.

Definition at line 71 of file pressureFvPatchScalarField.C.

Member Function Documentation

◆ TypeName()

TypeName ( "pressure"  )

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 131 of file pressureFvPatchScalarField.H.

References pressureFvPatchScalarField::pressureFvPatchScalarField().

Here is the call graph for this function:

◆ p() [1/2]

const scalarField& p ( ) const
inline

Return the static pressure.

Definition at line 148 of file pressureFvPatchScalarField.H.

References pressureFvPatchScalarField::p_.

Referenced by pressureFvPatchScalarField::pressureFvPatchScalarField().

Here is the caller graph for this function:

◆ p() [2/2]

scalarField& p ( )
inline

Return reference to the static pressure to allow adjustment.

Definition at line 154 of file pressureFvPatchScalarField.H.

References pressureFvPatchScalarField::p_.

◆ map()

void map ( const fvPatchScalarField &  ptf,
const fieldMapper &  mapper 
)
virtual

Map the given fvPatchField onto this fvPatchField.

Definition at line 84 of file pressureFvPatchScalarField.C.

References pressureFvPatchScalarField::p_.

◆ reset()

void reset ( const fvPatchScalarField &  ptf)
virtual

Reset the fvPatchField to the given fvPatchField.

Used for mesh to mesh mapping

Definition at line 99 of file pressureFvPatchScalarField.C.

References pressureFvPatchScalarField::p_.

◆ updateCoeffs()

void updateCoeffs ( )
virtual

Update the coefficients associated with the patch field.

Definition at line 113 of file pressureFvPatchScalarField.C.

References Foam::operator==().

Here is the call graph for this function:

◆ write()

void write ( Ostream &  os) const
virtual

Write.

Definition at line 126 of file pressureFvPatchScalarField.C.

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

Here is the call graph for this function:

Member Data Documentation

◆ p_

scalarField p_
protected

Static pressure.

Definition at line 91 of file pressureFvPatchScalarField.H.

Referenced by pressureFvPatchScalarField::map(), pressureFvPatchScalarField::p(), pressureFvPatchScalarField::pressureFvPatchScalarField(), and pressureFvPatchScalarField::reset().

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