limitMag Class Reference

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

Inheritance diagram for limitMag:

Collaboration diagram for limitMag:

Public Member Functions
	TypeName ("limitMag")
	Runtime type information. More...
	limitMag (const word &name, const word &modelType, const fvMesh &mesh, const dictionary &dict)
	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 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 dictionary &) const
	Return the coefficients sub-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 magnitude of the specified field to the specified max value.

Usage

Example usage:

limitU
{
    type            limitMag;

    cellZone        all;

    field           U;

    max             100;
}

Source files

• limitMag.H
• limitMag.C

Definition at line 66 of file limitMag.H.

Constructor & Destructor Documentation

limitMag() [1/2]

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

Construct from components.

Definition at line 111 of file limitMag.C.

References fvConstraint::coeffs(), and dict.

Here is the call graph for this function:

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.

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.

FOR_ALL_FIELD_TYPES()

FOR_ALL_FIELD_TYPES

(

DEFINE_FV_CONSTRAINT_CONSTRAIN_FIELD

)

Add a constraint to an equation.

movePoints()

bool movePoints ( )

virtual

Update for mesh motion.

Implements fvConstraint.

Definition at line 143 of file limitMag.C.

topoChange()

void topoChange ( const polyTopoChangeMap &  map )

virtual

Update topology using the given map.

Implements fvConstraint.

Definition at line 150 of file limitMag.C.

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.

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.

read()

bool read ( const dictionary &  dict )

virtual

Read dictionary.

Reimplemented from fvConstraint.

Definition at line 168 of file limitMag.C.

References dict, and fvConstraint::read().

Here is the call graph for this function:

operator=()

void operator= ( const limitMag &  )

delete

Disallow default bitwise assignment.

---

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

• src/fvConstraints/limitMag/limitMag.H
• src/fvConstraints/limitMag/limitMag.C