Public Member Functions | List of all members
limitMag Class Reference

Limits the magnitude of the specified field to the specified max value. More...

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

Public Member Functions

 TypeName ("limitMag")
 Runtime type information. More...
 
 limitMag (const word &name, const word &modelType, const dictionary &dict, const fvMesh &mesh)
 Construct from components. More...
 
 limitMag (const limitMag &)=delete
 Disallow default bitwise copy construction. More...
 
virtual ~limitMag ()
 Destructor. More...
 
virtual wordList constrainedFields () const
 Return the list of fields constrained by the fvConstraint. More...
 
 FOR_ALL_FIELD_TYPES (DEFINE_FV_CONSTRAINT_CONSTRAIN_FIELD)
 Add a constraint to an equation. 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 limitMag &)=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 dictionary &dict, const fvMesh &mesh),(name, constraintType, dict, mesh))
 
 fvConstraint (const word &name, const word &constraintType, const dictionary &dict, const fvMesh &mesh)
 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 dictionary &dict, const fvMesh &mesh)
 Return a reference to the selected fvConstraint. More...
 

Detailed Description

Limits the magnitude of the specified field to the specified max value.

Usage
Example usage: 
limitU
{
    type            limitMag;

    selectionMode   all;

    field           U;

    max             100;
}
Source files

Definition at line 66 of file limitMag.H.

Constructor & Destructor Documentation

◆ limitMag() [1/2]

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

Construct from components.

Definition at line 112 of file limitMag.C.

◆ limitMag() [2/2]

limitMag ( const limitMag &  )
delete

Disallow default bitwise copy construction.

◆ ~limitMag()

virtual ~limitMag ( )
inlinevirtual

Destructor.

Definition at line 117 of file limitMag.H.

References limitMag::constrainedFields(), DEFINE_FV_CONSTRAINT_CONSTRAIN_FIELD, limitMag::distribute(), limitMag::FOR_ALL_FIELD_TYPES(), limitMag::mapMesh(), limitMag::movePoints(), limitMag::operator=(), limitMag::read(), and limitMag::topoChange().

Here is the call graph for this function:

Member Function Documentation

◆ TypeName()

TypeName ( "limitMag"  )

Runtime type information.

◆ constrainedFields()

Foam::wordList constrainedFields ( ) const
virtual

Return the list of fields constrained by the fvConstraint.

Reimplemented from fvConstraint.

Definition at line 130 of file limitMag.C.

References Foam::FOR_ALL_FIELD_TYPES(), and IMPLEMENT_FV_CONSTRAINT_CONSTRAIN_FIELD.

Referenced by limitMag::~limitMag().

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

◆ FOR_ALL_FIELD_TYPES()

FOR_ALL_FIELD_TYPES ( DEFINE_FV_CONSTRAINT_CONSTRAIN_FIELD  )

Add a constraint to an equation.

Referenced by limitMag::~limitMag().

Here is the caller graph for this function:

◆ movePoints()

bool movePoints ( )
virtual

Update for mesh motion.

Implements fvConstraint.

Definition at line 143 of file limitMag.C.

Referenced by limitMag::~limitMag().

Here is the caller graph for this function:

◆ topoChange()

void topoChange ( const polyTopoChangeMap &  map)
virtual

Update topology using the given map.

Implements fvConstraint.

Definition at line 150 of file limitMag.C.

Referenced by limitMag::~limitMag().

Here is the caller graph for this function:

◆ mapMesh()

void mapMesh ( const polyMeshMap &  map)
virtual

Update from another mesh using the given map.

Implements fvConstraint.

Definition at line 156 of file limitMag.C.

Referenced by limitMag::~limitMag().

Here is the caller graph for this function:

◆ distribute()

void distribute ( const polyDistributionMap &  map)
virtual

Redistribute or update using the given distribution map.

Implements fvConstraint.

Definition at line 162 of file limitMag.C.

Referenced by limitMag::~limitMag().

Here is the caller graph for this function:

◆ read()

bool read ( const dictionary &  dict)
virtual

Read dictionary.

Reimplemented from fvConstraint.

Definition at line 168 of file limitMag.C.

References fvConstraint::read().

Referenced by limitMag::~limitMag().

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

◆ operator=()

void operator= ( const limitMag &  )
delete

Disallow default bitwise assignment.

Referenced by limitMag::~limitMag().

Here is the caller graph for this function:
The documentation for this class was generated from the following files: