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

#include <limitFields.H>

Inheritance diagram for limitFields:

Collaboration diagram for limitFields:

[legend]

Public Types
enum	limitType : unsigned { CLAMP_NONE = 0 , CLAMP_MIN = 0x1 , CLAMP_MAX = 0x2 , CLAMP_RANGE = (CLAMP_MIN \| CLAMP_MAX) }

Public Member Functions
	TypeName ("limitFields")
	Runtime type information.
	limitFields (const word &name, const Time &runTime, const dictionary &dict)
	Construct from name, Time and dictionary.
	limitFields (const limitFields &)=delete
	No copy construct.
void	operator= (const limitFields &)=delete
	No copy assignment.
virtual	~limitFields ()=default
	Destructor.
virtual bool	read (const dictionary &dict)
	Read the function-object dictionary.
virtual bool	execute ()
	Execute the function-object operations.
virtual bool	write ()
	Write the function-object results.
Public Member Functions inherited from fvMeshFunctionObject
	TypeName ("fvMeshFunctionObject")
	Runtime type information.
	fvMeshFunctionObject (const word &name, const Time &runTime, const dictionary &dict)
	Construct from Time and dictionary.
	fvMeshFunctionObject (const word &name, const objectRegistry &obr, const dictionary &dict)
	Construct from the region objectRegistry and dictionary.
virtual	~fvMeshFunctionObject ()=default
	Destructor.
Public Member Functions inherited from regionFunctionObject
	TypeName ("regionFunctionObject")
	Runtime type information.
	regionFunctionObject (const word &name, const Time &runTime, const dictionary &dict)
	Construct from Time and dictionary.
	regionFunctionObject (const word &name, const objectRegistry &obr, const dictionary &dict)
	Construct from the region objectRegistry and dictionary.
virtual	~regionFunctionObject ()=default
	Destructor.
template<class ObjectType>
const ObjectType *	lookupObjectPtr (const word &fieldName) const
	Deprecated(2018-10).
template<class ObjectType>
ObjectType *	lookupObjectRefPtr (const word &fieldName) const
	Deprecated(2018-10).
Public Member Functions inherited from stateFunctionObject
	stateFunctionObject (const word &name, const Time &runTime)
	Construct from components.
virtual	~stateFunctionObject ()=default
	Destructor.
dictionary &	propertyDict ()
	Return access to the property dictionary.
bool	foundProperty (const word &entryName) const
	Return true if the property exists.
void	clearTrigger ()
	Remove the trigger index from the properties.
label	getTrigger () const
	Get the current trigger index.
bool	setTrigger (const label triggeri)
	Set new trigger index.
bool	getDict (const word &entryName, dictionary &dict) const
	Set dictionary, return true if set.
bool	getObjectDict (const word &objectName, const word &entryName, dictionary &dict) const
	Set dictionary from named object, return true if set.
template<class Type>
Type	getProperty (const word &entryName, const Type &defaultValue=Type(Zero)) const
	Retrieve generic property.
template<class Type>
bool	getProperty (const word &entryName, Type &value) const
	Set generic property, return true if set.
template<class Type>
void	setProperty (const word &entryName, const Type &value)
	Add generic property.
template<class Type>
Type	getObjectProperty (const word &objectName, const word &entryName, const Type &defaultValue=Type(Zero)) const
	Retrieve generic property from named object.
template<class Type>
bool	getObjectProperty (const word &objectName, const word &entryName, Type &value) const
	Set generic property from named object, return true if set.
template<class Type>
void	setObjectProperty (const word &objectName, const word &entryName, const Type &value)
	Add generic property from named object.
bool	getObjectResultDict (const word &objectName, dictionary &dict) const
template<class Type>
void	setResult (const word &entryName, const Type &value)
	Add result.
template<class Type>
void	setObjectResult (const word &objectName, const word &entryName, const Type &value)
	Add result from named object.
template<class Type>
Type	getResult (const word &entryName, const Type &defaultValue=Type(Zero)) const
	Retrieve result.
template<class Type>
Type	getObjectResult (const word &objectName, const word &entryName, const Type &defaultValue=Type(Zero)) const
	Retrieve result from named object.
template<class Type>
bool	getObjectResult (const word &objectName, const word &entryName, Type &value) const
	Set result from named object, return true if set.
word	resultType (const word &entryName) const
	Retrieve the result type.
word	objectResultType (const word &objectName, const word &entryName) const
	Return the type of result.
wordList	objectResultEntries () const
	Retrieve the result entries.
wordList	objectResultEntries (const word &objectName) const
	Return result entries for named object.
void	writeResultEntries (Ostream &os) const
	Write the results entries for all objects to stream.
void	writeResultEntries (const word &objectName, Ostream &os) const
	Write the results entries for named object to stream.
void	writeAllResultEntries (Ostream &os) const
	Write the results entries for all objects to stream.
Public Member Functions inherited from timeFunctionObject
	timeFunctionObject (const word &name, const Time &runTime)
	Construct from Time.
virtual	~timeFunctionObject ()=default
	Destructor.
const Time &	time () const
	Return time database.
objectRegistry &	storedObjects ()
	Write access to the output objects ("functionObjectObjects") registered on Time.
const objectRegistry &	storedObjects () const
	Const access to the output objects ("functionObjectObjects") registered on Time.
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.
autoPtr< functionObject >	clone () const
	Return clone.
virtual	~functionObject ()=default
	Destructor.
virtual const word &	type () const =0
	Runtime type information.
const word &	name () const noexcept
	Return the name of this functionObject.
bool	useNamePrefix () const noexcept
	Return the flag for adding a scoping name prefix.
bool	useNamePrefix (bool on) noexcept
	Modify the flag for adding a scoping name prefix.
virtual bool	execute (const label subIndex)
	Execute using the specified subIndex.
virtual bool	end ()
	Called when Time::run() determines that the time-loop exits.
virtual bool	adjustTimeStep ()
	Called at the end of Time::adjustDeltaT() if adjustTime is true.
virtual bool	filesModified () const
	Did any file get changed during execution?
virtual void	updateMesh (const mapPolyMesh &mpm)
	Update for changes of mesh.
virtual void	movePoints (const polyMesh &mesh)
	Update for changes of mesh.

Protected Member Functions
bool	limitScalarField (const word &fieldName)
	Limit a scalar field.
template<class Type>
bool	limitField (const word &fieldName)
	Limit a field.
Protected Member Functions inherited from fvMeshFunctionObject
	fvMeshFunctionObject (const fvMeshFunctionObject &)=delete
	No copy construct.
void	operator= (const fvMeshFunctionObject &)=delete
	No copy assignment.
Protected Member Functions inherited from regionFunctionObject
virtual const objectRegistry &	obr () const
	The region or sub-region registry being used.
template<class ObjectType>
bool	foundObject (const word &fieldName) const
	Find object (eg, a field) in the (sub) objectRegistry.
template<class ObjectType>
const ObjectType *	cfindObject (const word &fieldName) const
	Return const pointer to the object (eg, a field) in the (sub) objectRegistry.
template<class ObjectType>
const ObjectType *	findObject (const word &fieldName) const
	Return const pointer to the object (eg, a field) in the (sub) objectRegistry.
template<class ObjectType>
ObjectType *	findObject (const word &fieldName)
	Return non-const pointer to the object of the given Type, (sub) objectRegistry.
template<class ObjectType>
ObjectType *	getObjectPtr (const word &fieldName) const
	Return non-const pointer to the object of the given Type, using a const-cast to have it behave like a mutable.
template<class ObjectType>
const ObjectType &	lookupObject (const word &fieldName) const
	Lookup and return object (eg, a field) from the (sub) objectRegistry.
template<class ObjectType>
ObjectType &	lookupObjectRef (const word &fieldName) const
	Lookup and return object (eg, a field) from the (sub) objectRegistry.
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.
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.
bool	writeObject (const word &fieldName)
	Write field if present in the (sub) objectRegistry.
bool	clearObject (const word &fieldName)
	Clear field from the (sub) objectRegistry if present.
void	clearObjects (const wordList &objNames)
	Clear fields from the (sub) objectRegistry if present.
	regionFunctionObject (const regionFunctionObject &)=delete
	No copy construct.
void	operator= (const regionFunctionObject &)=delete
	No copy assignment.
Protected Member Functions inherited from stateFunctionObject
const functionObjects::properties &	stateDict () const
	Return a const reference to the state dictionary.
functionObjects::properties &	stateDict ()
	Return non-const access to the state dictionary.
	stateFunctionObject (const stateFunctionObject &)=delete
	No copy construct.
void	operator= (const stateFunctionObject &)=delete
	No copy assignment.
Protected Member Functions inherited from timeFunctionObject
void	clearOutputObjects (const wordList &objNames)
	Remove specified items from "functionObjectObjects".
	timeFunctionObject (const timeFunctionObject &)=delete
	No copy construct.
void	operator= (const timeFunctionObject &)=delete
	No copy assignment.
Protected Member Functions inherited from functionObject
word	scopedName (const word &name) const
	Return a scoped (prefixed) name.

Protected Attributes
volFieldSelection	fieldSet_
	Fields to limit.
limitType	withBounds_
	Limiting type.
scalar	min_
	Minimum limit.
scalar	max_
	Maximum limit.
Protected Attributes inherited from fvMeshFunctionObject
const fvMesh &	mesh_
	Reference to the fvMesh.
Protected Attributes inherited from regionFunctionObject
word	subRegistryName_
	Name for alternative object registry.
const objectRegistry &	obr_
	Reference to the region objectRegistry.
const objectRegistry *	obrPtr_
	Pointer to alternative (eg, sub-region) objectRegistry.
Protected Attributes inherited from timeFunctionObject
const Time &	time_
	Reference to the time database.

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

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.
Public Attributes inherited from functionObject
bool	log
	Flag to write log into Info.
Static Public Attributes inherited from functionObject
static int	debug
	Flag to execute debug content.
static bool	postProcess
	Global post-processing mode switch.
static bool	defaultUseNamePrefix
	Global default for useNamePrefix.
static word	outputPrefix
	Directory prefix.

Detailed Description

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

Operands:

Operand	Type	Location
`input`	vol<Type>Field	<time>/inputField
`output` file	-	-
`output` field	vol<Type>Field	<time>/outputField

where Type can be one of: Scalar, Vector, SphericalTensor, SymmTensor, or Tensor.

Usage

Minimal example by using system/controlDict.functions:

limitFieldsFO
{
    // Mandatory entries
    type            limitFields;
    libs            (fieldFunctionObjects);
    fields          <wordList>;       // (field1 field2 ... fieldN)
    limit           <word>;

    // Conditional entries

        // when limit = min or both
        min             <scalar>;

        // when limit = max or both
        max             <scalar>;

    // Inherited entries
    ...
}

where the entries mean:

Property	Description	Type	Reqd	Deflt
`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	-

The inherited entries are elaborated in:

functionObject.H

Options for the limit entry:

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

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

Source files

Definition at line 172 of file limitFields.H.

Member Enumeration Documentation

◆ limitType

enum limitType : unsigned

Enumerator
CLAMP_NONE	No limit.
CLAMP_MIN	Clamp minimum value.
CLAMP_MAX	Clamp maximum value.
CLAMP_RANGE	Clamp min/max.

Definition at line 180 of file limitFields.H.

Constructor & Destructor Documentation

◆ limitFields() [1/2]

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

Construct from name, Time and dictionary.

Definition at line 101 of file limitFields.C.

References CLAMP_NONE, dict, fieldSet_, fvMeshFunctionObject::fvMeshFunctionObject(), max_, fvMeshFunctionObject::mesh_, min_, Foam::name(), read(), runTime, and withBounds_.

Referenced by limitFields(), and operator=().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ limitFields() [2/2]

limitFields ( const limitFields & )

delete

No copy construct.

References limitFields().

Here is the call graph for this function:

◆ ~limitFields()

virtual ~limitFields ( )

virtualdefault

Destructor.

References dict.

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 51 of file limitFields.C.

References CLAMP_MAX, CLAMP_MIN, CLAMP_NONE, CLAMP_RANGE, Foam::endl(), field(), Foam::gMinMax(), Log, MinMax< T >::max(), max_, MinMax< T >::min(), min_, regionFunctionObject::obr_, and withBounds_.

Referenced by execute().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ limitField()

template<class Type>

bool limitField ( const word & fieldName )

protected

Limit a field.

Returns: true if field of this type was found.

Definition at line 27 of file limitFieldsTemplates.C.

References CLAMP_MAX, CLAMP_MIN, Foam::endl(), field(), regionFunctionObject::getObjectPtr(), Foam::GlobalIOList< Tuple2< scalar, vector > >::typeName, Foam::gMax(), Foam::gMin(), Log, Foam::mag(), max_, min_, GeometricField< scalar, fvPatchField, volMesh >::New(), IOobjectOption::NO_REGISTER, IOobject::scopedName(), and withBounds_.

Referenced by execute().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ TypeName()

TypeName ( "limitFields" )

Runtime type information.

References dict, Foam::name(), and runTime.

Here is the call graph for this function:

◆ operator=()

void operator= ( const limitFields & )

delete

No copy assignment.

References limitFields().

Here is the call graph for this function:

◆ read()

bool read ( const dictionary & dict )

virtual

Read the function-object dictionary.

Reimplemented from regionFunctionObject.

Definition at line 120 of file limitFields.C.

References CLAMP_MAX, CLAMP_MIN, CLAMP_NONE, dict, Foam::endl(), fieldSet_, Foam::Info, limitTypeNames_, max_, min_, name, Foam::nl, functionObject::read(), Foam::type(), and withBounds_.

Referenced by limitFields().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ execute()

bool execute ( )

virtual

Execute the function-object operations.

Implements functionObject.

Definition at line 153 of file limitFields.C.

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

Here is the call graph for this function:

◆ write()

bool write ( )

virtual

Write the function-object results.

Implements functionObject.

Definition at line 188 of file limitFields.C.

References fieldSet_, and regionFunctionObject::lookupObject().

Here is the call graph for this function:

Member Data Documentation

◆ limitTypeNames_

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

staticprotected

Limit type names.

Definition at line 196 of file limitFields.H.

Referenced by read().

◆ fieldSet_

volFieldSelection fieldSet_

protected

Fields to limit.

Definition at line 201 of file limitFields.H.

Referenced by execute(), limitFields(), read(), and write().

◆ withBounds_

limitType withBounds_

protected

Limiting type.

Definition at line 206 of file limitFields.H.

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

◆ min_

scalar min_

protected

Minimum limit.

Definition at line 211 of file limitFields.H.

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

◆ max_

scalar max_

protected

Maximum limit.

Definition at line 216 of file limitFields.H.

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

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_

◆ fieldSet_

◆ withBounds_

◆ min_

◆ max_