Limits input fields to user-specified min and max bounds. More...

Inheritance diagram for limitFields:

Collaboration diagram for limitFields:

Public Types
enum	limitType : unsigned { MIN = 0x1 , MAX = 0x2 , BOTH = (MIN \| MAX) }

Public Member Functions
	TypeName ("limitFields")
	Runtime type information. More...

	limitFields (const word &name, const Time &runTime, const dictionary &dict)
	Construct from Time and dictionary. More...

	limitFields (const limitFields &)=delete
	No copy construct. More...

void	operator= (const limitFields &)=delete
	No copy assignment. More...

virtual	~limitFields ()=default
	Destructor. More...

virtual bool	read (const dictionary &dict)
	Read the field min/max data. More...

virtual bool	execute ()
	Execute, currently does nothing. More...

virtual bool	write ()
	Write the limitFields. More...

Public Member Functions inherited from fvMeshFunctionObject
	TypeName ("fvMeshFunctionObject")
	Runtime type information. More...

	fvMeshFunctionObject (const word &name, const Time &runTime, const dictionary &dict)
	Construct from Time and dictionary. More...

	fvMeshFunctionObject (const word &name, const objectRegistry &obr, const dictionary &dict)
	Construct from the region objectRegistry and dictionary. More...

virtual	~fvMeshFunctionObject ()=default
	Destructor. More...

Public Member Functions inherited from regionFunctionObject
	TypeName ("regionFunctionObject")
	Runtime type information. More...

	regionFunctionObject (const word &name, const Time &runTime, const dictionary &dict)
	Construct from Time and dictionary. More...

	regionFunctionObject (const word &name, const objectRegistry &obr, const dictionary &dict)
	Construct from the region objectRegistry and dictionary. More...

virtual	~regionFunctionObject ()=default
	Destructor. More...

virtual bool	read (const dictionary &dict)
	Read optional controls. More...

template<class ObjectType >
const ObjectType *	lookupObjectPtr (const word &fieldName) const
	Deprecated(2018-10) More...

template<class ObjectType >
ObjectType *	lookupObjectRefPtr (const word &fieldName) const
	Deprecated(2018-10) More...

Public Member Functions inherited from stateFunctionObject
	stateFunctionObject (const word &name, const Time &runTime)
	Construct from components. More...

virtual	~stateFunctionObject ()=default
	Destructor. More...

dictionary &	propertyDict ()
	Return access to the property dictionary. More...

bool	foundProperty (const word &entryName) const
	Return true if the property exists. More...

void	clearTrigger ()
	Remove the trigger index from the properties. More...

label	getTrigger () const
	Get the current trigger index. More...

bool	setTrigger (const label triggeri)
	Set new trigger index. More...

bool	getDict (const word &entryName, dictionary &dict) const
	Set dictionary, return true if set. More...

bool	getObjectDict (const word &objectName, const word &entryName, dictionary &dict) const
	Set dictionary from named object, return true if set. More...

template<class Type >
Type	getProperty (const word &entryName, const Type &defaultValue=Type(Zero)) const
	Retrieve generic property. More...

template<class Type >
bool	getProperty (const word &entryName, Type &value) const
	Set generic property, return true if set. More...

template<class Type >
void	setProperty (const word &entryName, const Type &value)
	Add generic property. More...

template<class Type >
Type	getObjectProperty (const word &objectName, const word &entryName, const Type &defaultValue=Type(Zero)) const
	Retrieve generic property from named object. More...

template<class Type >
bool	getObjectProperty (const word &objectName, const word &entryName, Type &value) const
	Set generic property from named object, return true if set. More...

template<class Type >
void	setObjectProperty (const word &objectName, const word &entryName, const Type &value)
	Add generic property from named object. More...

template<class Type >
void	setResult (const word &entryName, const Type &value)
	Add result. More...

template<class Type >
void	setObjectResult (const word &objectName, const word &entryName, const Type &value)
	Add result from named object. More...

template<class Type >
Type	getResult (const word &entryName, const Type &defaultValue=Type(Zero)) const
	Retrieve result. More...

template<class Type >
Type	getObjectResult (const word &objectName, const word &entryName, const Type &defaultValue=Type(Zero)) const
	Retrieve result from named object. More...

template<class Type >
bool	getObjectResult (const word &objectName, const word &entryName, Type &value) const
	Set result from named object, return true if set. More...

word	resultType (const word &entryName) const
	Retrieve the result type. More...

word	objectResultType (const word &objectName, const word &entryName) const
	Return the type of result. More...

wordList	objectResultEntries () const
	Retrieve the result entries. More...

wordList	objectResultEntries (const word &objectName) const
	Return result entries for named object. More...

void	writeResultEntries (Ostream &os) const
	Write the results entries for all objects to stream. More...

void	writeResultEntries (const word &objectName, Ostream &os) const
	Write the results entries for named object to stream. More...

void	writeAllResultEntries (Ostream &os) const
	Write the results entries for all objects to stream. More...

Public Member Functions inherited from timeFunctionObject
	timeFunctionObject (const word &name, const Time &runTime)
	Construct from Time. More...

virtual	~timeFunctionObject ()=default
	Destructor. More...

const Time &	time () const
	Return time database. More...

objectRegistry &	storedObjects ()

const objectRegistry &	storedObjects () const

Public Member Functions inherited from functionObject
	declareRunTimeSelectionTable (autoPtr, functionObject, dictionary,(const word &name, const Time &runTime, const dictionary &dict),(name, runTime, dict))

	functionObject (const word &name, const bool withNamePrefix=defaultUseNamePrefix)
	Construct from components. More...

autoPtr< functionObject >	clone () const
	Return clone. More...

virtual	~functionObject ()=default
	Destructor. More...

virtual const word &	type () const =0
	Runtime type information. More...

const word &	name () const noexcept
	Return the name of this functionObject. More...

bool	useNamePrefix () const noexcept
	Return the flag for adding a scoping name prefix. More...

bool	useNamePrefix (bool on) noexcept
	Modify the flag for adding a scoping name prefix. More...

virtual bool	read (const dictionary &dict)
	Read and set the function object if its data have changed. More...

virtual bool	execute ()=0
	Called at each ++ or += of the time-loop. More...

virtual bool	execute (const label subIndex)
	Execute using the specified subIndex. More...

virtual bool	write ()=0
	Called at each ++ or += of the time-loop. More...

virtual bool	end ()
	Called when Time::run() determines that the time-loop exits. More...

virtual bool	adjustTimeStep ()
	Called at the end of Time::adjustDeltaT() if adjustTime is true. More...

virtual bool	filesModified () const
	Did any file get changed during execution? More...

virtual void	updateMesh (const mapPolyMesh &mpm)
	Update for changes of mesh. More...

virtual void	movePoints (const polyMesh &mesh)
	Update for changes of mesh. More...

Protected Member Functions
bool	limitScalarField (const word &fieldName)
	Limit a scalar field. More...

template<class Type >
bool	limitField (const word &fieldName)
	Limit a field. More...

Protected Member Functions inherited from fvMeshFunctionObject
	fvMeshFunctionObject (const fvMeshFunctionObject &)=delete
	No copy construct. More...

void	operator= (const fvMeshFunctionObject &)=delete
	No copy assignment. More...

Protected Member Functions inherited from regionFunctionObject
virtual const objectRegistry &	obr () const
	The region or sub-region registry being used. More...

template<class ObjectType >
bool	foundObject (const word &fieldName) const
	Find object (eg, a field) in the (sub) objectRegistry. More...

template<class ObjectType >
const ObjectType *	cfindObject (const word &fieldName) const

template<class ObjectType >
const ObjectType *	findObject (const word &fieldName) const

template<class ObjectType >
ObjectType *	findObject (const word &fieldName)

template<class ObjectType >
ObjectType *	getObjectPtr (const word &fieldName) const

template<class ObjectType >
const ObjectType &	lookupObject (const word &fieldName) const
	Lookup and return object (eg, a field) from the (sub) objectRegistry. More...

template<class ObjectType >
ObjectType &	lookupObjectRef (const word &fieldName) const
	Lookup and return object (eg, a field) from the (sub) objectRegistry. More...

template<class ObjectType >
bool	store (word &fieldName, const tmp< ObjectType > &tfield, bool cacheable=false)
	Store the field in the (sub) objectRegistry under the given name. More...

template<class ObjectType >
bool	storeInDb (const word &fieldName, const tmp< ObjectType > &tfield, const objectRegistry &obr)
	Store the field in an optional objectRegistry under the given name. More...

bool	writeObject (const word &fieldName)
	Write field if present in the (sub) objectRegistry. More...

bool	clearObject (const word &fieldName)
	Clear field from the (sub) objectRegistry if present. More...

void	clearObjects (const wordList &objNames)
	Clear fields from the (sub) objectRegistry if present. More...

	regionFunctionObject (const regionFunctionObject &)=delete
	No copy construct. More...

void	operator= (const regionFunctionObject &)=delete
	No copy assignment. More...

Protected Member Functions inherited from stateFunctionObject
const functionObjects::properties &	stateDict () const
	Return a const reference to the state dictionary. More...

functionObjects::properties &	stateDict ()
	Return non-const access to the state dictionary. More...

	stateFunctionObject (const stateFunctionObject &)=delete
	No copy construct. More...

void	operator= (const stateFunctionObject &)=delete
	No copy assignment. More...

Protected Member Functions inherited from timeFunctionObject
void	clearOutputObjects (const wordList &objNames)
	Remove specified items from "functionObjectObjects". More...

	timeFunctionObject (const timeFunctionObject &)=delete
	No copy construct. More...

void	operator= (const timeFunctionObject &)=delete
	No copy assignment. More...

Protected Member Functions inherited from functionObject
word	scopedName (const word &name) const
	Return a scoped (prefixed) name. More...

Protected Attributes
limitType	limit_
	Limiting type. More...

volFieldSelection	fieldSet_
	Fields to limit. More...

scalar	min_
	Minimum limit. More...

scalar	max_
	Maximum limit. More...

Protected Attributes inherited from fvMeshFunctionObject
const fvMesh &	mesh_
	Reference to the fvMesh. More...

Protected Attributes inherited from regionFunctionObject
word	subRegistryName_
	Name for alternative object registry. More...

const objectRegistry &	obr_
	Reference to the region objectRegistry. More...

const objectRegistry *	obrPtr_
	Pointer to alternative (eg, sub-region) objectRegistry. More...

Protected Attributes inherited from timeFunctionObject
const Time &	time_
	Reference to the time database. More...

Static Protected Attributes
static const Enum< limitType >	limitTypeNames_
	Limit type names. More...

Additional Inherited Members
Static Public Member Functions inherited from functionObject
static autoPtr< functionObject >	New (const word &name, const Time &runTime, const dictionary &dict)
	Select from dictionary, based on its "type" entry. More...

Public Attributes inherited from functionObject
bool	log
	Flag to write log into Info. More...

Static Public Attributes inherited from functionObject
static int	debug
	Flag to execute debug content. More...

static bool	postProcess
	Global post-processing mode switch. More...

static bool	defaultUseNamePrefix
	Global default for useNamePrefix. More...

static word	outputPrefix
	Directory prefix. More...

Detailed Description

Limits input fields to user-specified min and max bounds.

Operands:

Operand	Type	Location
`input`	vol<Type>Field	$FOAM_CASE/<time>/<inpField>
`output` file	-	-
`output` field	vol<Type>Field	$FOAM_CASE/<time>/<outField>

where <Type>=Scalar/Vector/SphericalTensor/SymmTensor/Tensor.

Note: For non-scalar types of input field, the user limit is used to create a scaling factor using the field magnitudes.

Usage

Minimal example by using system/controlDict.functions:

limitFields1
{
    // Mandatory entries (unmodifiable)
    type            limitFields;
    libs            (fieldFunctionObjects);

    // Mandatory entries (runtime modifiable)
    fields          (U);
    limit           max;
    max             100;

    // Optional (inherited) entries
    ...
}

where the entries mean:

Property	Description	Type	Req'd	Dflt
`type`	Type name: limitFields	word	yes	-
`libs`	Library name: fieldFunctionObjects	word	yes	-
`fields`	List of fields to process	wordList	yes	-
`limit`	Bound to limit - see below	word	yes	-
`min`	Min limit value	scalar	conditional	-
`max`	Max limit value	scalar	conditional	-

Options for the limit entry:

        min  : specify a minimum value
        max  : specify a maximum value
        both : specify a minimum value and a maximum value

The inherited entries are elaborated in:

functionObject.H

Usage by the postProcess utility is not available.

See also

Foam::functionObject
Foam::functionObjects::fvMeshFunctionObject
ExtendedCodeGuide::functionObjects::field::limitFields

Source files

Definition at line 177 of file limitFields.H.

Member Enumeration Documentation

◆ limitType

enum limitType : unsigned

Enumerator
MIN	limit by minimum value
MAX	limit by maximum value
BOTH	limit by both minimum and maximum values

Definition at line 185 of file limitFields.H.

Constructor & Destructor Documentation

◆ limitFields() [1/2]

limitFields	(	const word &	name,
		const Time &	runTime,
		const dictionary &	dict
	)

Construct from Time and dictionary.

Definition at line 88 of file limitFields.C.

References dict, and limitFields::read().

Here is the call graph for this function:

◆ limitFields() [2/2]

limitFields ( const limitFields & )

delete

No copy construct.

◆ ~limitFields()

virtual ~limitFields ( )

virtualdefault

Destructor.

Member Function Documentation

◆ limitScalarField()

bool limitScalarField ( const word & fieldName )

protected

Limit a scalar field.

Returns: true if field of this type was found.

Definition at line 57 of file limitFields.C.

References field(), objectRegistry::getObjectPtr(), Foam::gMax(), Foam::gMin(), limitFields::limit_, Log, limitFields::MAX, limitFields::max_, limitFields::MIN, limitFields::min_, and regionFunctionObject::obr_.

Here is the call graph for this function:

◆ limitField()

bool limitField ( const word & fieldName )

protected

Limit a field.

Returns: true if field of this type was found.

Definition at line 34 of file limitFieldsTemplates.C.

References field(), Foam::gMax(), Foam::gMin(), limitFields::limit_, Log, limitFields::MAX, GeometricField< Type, PatchField, GeoMesh >::max(), limitFields::max_, limitFields::MIN, GeometricField< Type, PatchField, GeoMesh >::min(), and limitFields::min_.

Here is the call graph for this function:

◆ TypeName()

TypeName ( "limitFields" )

Runtime type information.

◆ operator=()

void operator= ( const limitFields & )

delete

No copy assignment.

◆ read()

bool read ( const dictionary & dict )

virtual

Read the field min/max data.

Reimplemented from regionFunctionObject.

Definition at line 107 of file limitFields.C.

References dict, Foam::endl(), Foam::Info, Foam::name(), Foam::nl, kEpsilonLopesdaCosta< BasicTurbulenceModel >::read(), and Foam::type().

Referenced by limitFields::limitFields().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ execute()

bool execute ( )

virtual

Execute, currently does nothing.

Implements functionObject.

Definition at line 138 of file limitFields.C.

References Foam::endl(), Log, Foam::name(), Foam::nl, and Foam::type().

Here is the call graph for this function:

◆ write()

bool write ( )

virtual

Write the limitFields.

Implements functionObject.

Definition at line 172 of file limitFields.C.

Member Data Documentation

◆ limitTypeNames_

const Foam::Enum< Foam::functionObjects::limitFields::limitType > limitTypeNames_

staticprotected

Limit type names.

Definition at line 198 of file limitFields.H.

◆ limit_

limitType limit_

protected

Limiting type.

Definition at line 201 of file limitFields.H.

Referenced by limitFields::limitField(), and limitFields::limitScalarField().

◆ fieldSet_

volFieldSelection fieldSet_

protected

Fields to limit.

Definition at line 204 of file limitFields.H.

◆ min_

scalar min_

protected

Minimum limit.

Definition at line 207 of file limitFields.H.

Referenced by limitFields::limitField(), and limitFields::limitScalarField().

◆ max_

scalar max_

protected

Maximum limit.

Definition at line 210 of file limitFields.H.

Referenced by limitFields::limitField(), and limitFields::limitScalarField().

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

src/functionObjects/field/limitFields/limitFields.H
src/functionObjects/field/limitFields/limitFields.C
src/functionObjects/field/limitFields/limitFieldsTemplates.C

Public Types

Public Member Functions

Protected Member Functions

Protected Attributes

Static Protected Attributes

Additional Inherited Members

Detailed Description

Member Enumeration Documentation

◆ limitType

Constructor & Destructor Documentation

◆ limitFields() [1/2]

◆ limitFields() [2/2]

◆ ~limitFields()

Member Function Documentation

◆ limitScalarField()

◆ limitField()

◆ TypeName()

◆ operator=()

◆ read()

◆ execute()

◆ write()

Member Data Documentation

◆ limitTypeNames_

◆ limit_

◆ fieldSet_

◆ min_

◆ max_