bound Class Reference

Bound the specified scalar field where it is below the specified minimum. More...

Inheritance diagram for bound:

Collaboration diagram for bound:

Public Member Functions
	TypeName ("bound")
	Runtime type information. More...
	bound (const word &name, const word &modelType, const fvMesh &mesh, const dictionary &dict)
	Construct from components. More...
	bound (const bound &)=delete
	Disallow default bitwise copy construction. More...
virtual	~bound ()
	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 bound &)=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

Bound the specified scalar field where it is below the specified minimum.

Where the field is unbounded it is set to the maximum of the average of the neighbouring cell values and the specified minimum.

Usage

Example usage:

limitp
{
    type            bound;

    field           p;

    min             100;
}

Source files

• boundConstraint.H
• bound.C

Definition at line 67 of file boundConstraint.H.

Constructor & Destructor Documentation

bound() [1/2]

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

Construct from components.

Definition at line 59 of file boundConstraint.C.

bound() [2/2]

bound ( const bound &  )

delete

Disallow default bitwise copy construction.

~bound()

virtual ~bound ( )

inlinevirtual

Destructor.

Definition at line 108 of file boundConstraint.H.

Member Function Documentation

TypeName()

TypeName

(

"bound"

)

Runtime type information.

constrainedFields()

Foam::wordList constrainedFields ( ) const

virtual

Return the list of fields constrained by the fvConstraint.

Reimplemented from fvConstraint.

Definition at line 77 of file boundConstraint.C.

constrain()

bool constrain ( volScalarField &  p ) const

virtual

Constrain the pressure field.

Definition at line 83 of file boundConstraint.C.

References Foam::bound(), and f().

Here is the call graph for this function:

movePoints()

bool movePoints ( )

virtual

Update for mesh motion.

Implements fvConstraint.

Definition at line 89 of file boundConstraint.C.

topoChange()

void topoChange ( const polyTopoChangeMap &  )

virtual

Update topology using the given map.

Implements fvConstraint.

Definition at line 95 of file boundConstraint.C.

mapMesh()

void mapMesh ( const polyMeshMap &  )

virtual

Update from another mesh using the given map.

Implements fvConstraint.

Definition at line 99 of file boundConstraint.C.

distribute()

void distribute ( const polyDistributionMap &  )

virtual

Redistribute or update using the given distribution map.

Implements fvConstraint.

Definition at line 103 of file boundConstraint.C.

read()

bool read ( const dictionary &  dict )

virtual

Read dictionary.

Reimplemented from fvConstraint.

Definition at line 107 of file boundConstraint.C.

References dict, and fvConstraint::read().

Here is the call graph for this function:

operator=()

void operator= ( const bound &  )

delete

Disallow default bitwise assignment.

---

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

• src/fvConstraints/bound/boundConstraint.H
• src/fvConstraints/bound/boundConstraint.C