limitPressure Class Reference

Limits the specified pressure field to be between specified minimum and maximum limits. More...

Inheritance diagram for limitPressure:
Collaboration diagram for limitPressure:

Public Member Functions

 TypeName ("limitPressure")
 Runtime type information. More...
 
 limitPressure (const word &name, const word &modelType, const fvMesh &mesh, const dictionary &dict)
 Construct from components. More...
 
 limitPressure (const limitPressure &)=delete
 Disallow default bitwise copy construction. More...
 
virtual ~limitPressure ()
 Destructor. More...
 
virtual wordList constrainedFields () const
 Return the list of fields constrained by the fvConstraint. More...
 
virtual bool constrain (volScalarField &p) const
 Constrain the pressure field. More...
 
virtual bool movePoints ()
 Update for mesh motion. More...
 
virtual void topoChange (const polyTopoChangeMap &)
 Update topology using the given map. More...
 
virtual void mapMesh (const polyMeshMap &)
 Update from another mesh using the given map. More...
 
virtual void distribute (const polyDistributionMap &)
 Redistribute or update using the given distribution map. More...
 
virtual bool read (const dictionary &dict)
 Read dictionary. More...
 
void operator= (const limitPressure &)=delete
 Disallow default bitwise assignment. More...
 
- Public Member Functions inherited from fvConstraint
 TypeName ("fvConstraint")
 Runtime type information. More...
 
 declareRunTimeSelectionTable (autoPtr, fvConstraint, dictionary,(const word &name, const word &constraintType, const fvMesh &mesh, const dictionary &dict),(name, constraintType, mesh, dict))
 
 fvConstraint (const word &name, const word &constraintType, const fvMesh &mesh, const dictionary &dict)
 Construct from components. More...
 
autoPtr< fvConstraint > clone () const
 Return clone. More...
 
virtual ~fvConstraint ()
 Destructor. More...
 
const word & name () const
 Return const access to the source name. More...
 
const fvMesh & mesh () const
 Return const access to the mesh database. More...
 
const dictionary & coeffs () const
 Return dictionary. More...
 
virtual bool constrainsField (const word &fieldName) const
 Return true if the given field is constrained. More...
 
 FOR_ALL_FIELD_TYPES (DEFINE_FV_CONSTRAINT_CONSTRAIN)
 Apply a constraint to an equation. More...
 
 FOR_ALL_FIELD_TYPES (DEFINE_FV_CONSTRAINT_CONSTRAIN_FIELD)
 Apply constraint to a field. More...
 

Additional Inherited Members

- Static Public Member Functions inherited from fvConstraint
static autoPtr< fvConstraint > New (const word &name, const fvMesh &mesh, const dictionary &dict)
 Return a reference to the selected fvConstraint. More...
 

Detailed Description

Limits the specified pressure field to be between specified minimum and maximum limits.

Usage
Example usage:
limitp
{
    type            limitPressure;

    // p               p_rgh; // Optional entry to specify the pressure

    min             200;
    max             500;
}
Source files

Definition at line 66 of file limitPressure.H.

Constructor & Destructor Documentation

◆ limitPressure() [1/2]

limitPressure ( const word &  name,
const word &  modelType,
const fvMesh &  mesh,
const dictionary &  dict 
)

Construct from components.

Definition at line 158 of file limitPressure.C.

◆ limitPressure() [2/2]

limitPressure ( const limitPressure &  )
delete

Disallow default bitwise copy construction.

◆ ~limitPressure()

virtual ~limitPressure ( )
inlinevirtual

Destructor.

Definition at line 116 of file limitPressure.H.

Member Function Documentation

◆ TypeName()

TypeName ( "limitPressure"  )

Runtime type information.

◆ constrainedFields()

Foam::wordList constrainedFields ( ) const
virtual

Return the list of fields constrained by the fvConstraint.

Reimplemented from fvConstraint.

Definition at line 179 of file limitPressure.C.

◆ constrain()

bool constrain ( volScalarField &  p) const
virtual

Constrain the pressure field.

Definition at line 185 of file limitPressure.C.

References Foam::endl(), Foam::Info, Foam::max(), Foam::min(), and p.

Here is the call graph for this function:

◆ movePoints()

bool movePoints ( )
virtual

Update for mesh motion.

Implements fvConstraint.

Definition at line 222 of file limitPressure.C.

◆ topoChange()

void topoChange ( const polyTopoChangeMap &  )
virtual

Update topology using the given map.

Implements fvConstraint.

Definition at line 228 of file limitPressure.C.

◆ mapMesh()

void mapMesh ( const polyMeshMap &  )
virtual

Update from another mesh using the given map.

Implements fvConstraint.

Definition at line 232 of file limitPressure.C.

◆ distribute()

void distribute ( const polyDistributionMap &  )
virtual

Redistribute or update using the given distribution map.

Implements fvConstraint.

Definition at line 236 of file limitPressure.C.

◆ read()

bool read ( const dictionary &  dict)
virtual

Read dictionary.

Reimplemented from fvConstraint.

Definition at line 240 of file limitPressure.C.

References dict, and fvConstraint::read().

Here is the call graph for this function:

◆ operator=()

void operator= ( const limitPressure &  )
delete

Disallow default bitwise assignment.


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