Computes the values and locations of field minima and maxima. These are good indicators of calculation performance, e.g. to confirm that predicted results are within expected bounds, or how well a case is converging. More...

Inheritance diagram for fieldMinMax:

[legend]

Collaboration diagram for fieldMinMax:

[legend]

Classes
struct	modeValueType
	Trait: the default output type (is component mode) More...

struct	modeValueType< T, modeType::mdMag >
	Trait: the output type (for magnitude mode) More...

Public Types
enum	modeType : char { mdMag, mdCmpt }
	Options for the mode types. More...

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

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

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

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

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

virtual bool	read (const dictionary &dict)
	Read the function-object dictionary. More...

virtual bool	execute ()
	Execute the function-object operations. More...

virtual bool	write ()
	Write the function-object results. 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...

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...

bool	getObjectResultDict (const word &objectName, dictionary &dict) const

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 ()
	Write access to the output objects ("functionObjectObjects") registered on Time. More...

const objectRegistry &	storedObjects () const
	Const access to the output objects ("functionObjectObjects") registered on Time. More...

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	execute (const label subIndex)
	Execute using the specified subIndex. 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...

Public Member Functions inherited from writeFile
	writeFile (const objectRegistry &obr, const fileName &prefix, const word &name="undefined", const bool writeToFile=true, const string &ext=".dat")
	Construct from objectRegistry, prefix, fileName. More...

	writeFile (const objectRegistry &obr, const fileName &prefix, const word &name, const dictionary &dict, const bool writeToFile=true, const string &ext=".dat")
	Construct from objectRegistry, prefix, fileName and read options from dictionary. More...

	writeFile (const writeFile &wf)
	Construct copy. More...

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

virtual const string &	setExt (const string &ext)
	Set extension. More...

virtual OFstream &	file ()
	Return access to the file (if only 1) More...

virtual bool	writeToFile () const
	Flag to allow writing to file. More...

virtual bool	canWriteToFile () const
	Flag to allow writing to the file. More...

virtual bool	canResetFile () const
	Flag to allow resetting the file. More...

virtual bool	canWriteHeader () const
	Flag to allow writing the header. More...

virtual label	charWidth () const
	Return width of character stream output. More...

virtual void	writeCommented (Ostream &os, const string &str) const
	Write a commented string to stream. More...

virtual void	writeTabbed (Ostream &os, const string &str) const
	Write a tabbed string to stream. More...

virtual void	writeHeader (Ostream &os, const string &str) const
	Write a commented header to stream. More...

virtual void	writeCurrentTime (Ostream &os) const
	Write the current time to stream. More...

virtual void	writeBreak (Ostream &os) const
	Write a break marker to the stream. More...

template<class Type >
void	writeHeaderValue (Ostream &os, const string &property, const Type &value) const
	Write a (commented) header property and value pair. More...

template<class Type >
void	writeValue (Ostream &os, const Type &val) const
	Write a given value to stream with the space delimiter. More...

Protected Types
template<class T , modeType Mode = modeType::mdCmpt>
using	modeValueType_t = typename modeValueType< T, Mode >::type
	Helper alias for modeValueType<T, Mode>::type. More...

Protected Member Functions
template<class Type >
void	output (const word &outputName, const label minCell, const label maxCell, const vector &minC, const vector &maxC, const label minProci, const label maxProci, const Type &minValue, const Type &maxValue)
	Helper function to write the output. More...

virtual void	writeFileHeader (Ostream &os)
	Output file header information. More...

template<class Type , modeType Mode = modeType::mdCmpt>
void	calcMinMaxFieldType (const GeometricField< Type, fvPatchField, volMesh > &field, const word &outputFieldName)
	Calculate the field min/max for a given field type, optionally forcing mag vs component calculation. More...

template<class Type >
bool	calcMinMaxFields (const word &fieldName, const modeType mode)
	Calculate the field min/max. 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
	Return const pointer to the object (eg, a field) in the (sub) objectRegistry. More...

template<class ObjectType >
const ObjectType *	findObject (const word &fieldName) const
	Return const pointer to the object (eg, a field) in the (sub) objectRegistry. More...

template<class ObjectType >
ObjectType *	findObject (const word &fieldName)
	Return non-const pointer to the object of the given Type, (sub) objectRegistry. More...

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. More...

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 Member Functions inherited from writeFile
void	initStream (Ostream &os) const
	Initialise the output stream for writing. More...

fileName	baseFileDir () const
	Return the base directory for output. More...

fileName	baseTimeDir () const
	Return the base directory for the current time value. More...

fileName	filePath (const fileName &fName) const
	Return the full path for the supplied file name. More...

virtual autoPtr< OFstream >	newFile (const fileName &fName) const
	Return autoPtr to a new file using file name. More...

virtual autoPtr< OFstream >	newFileAtTime (const word &name, scalar timeValue) const
	Return autoPtr to a new file for a given time. More...

virtual autoPtr< OFstream >	newFileAtStartTime (const word &name) const
	Return autoPtr to a new file using the simulation start time. More...

virtual void	resetFile (const word &name)
	Reset internal file pointer to new file with new name. More...

Omanip< int >	valueWidth (const label offset=0) const
	Return the value width when writing to stream with optional offset. More...

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

virtual autoPtr< OFstream >	createFile (const word &name, scalar timeValue) const
	Deprecated(2022-09) Return autoPtr to a new file for a given time. More...

virtual autoPtr< OFstream >	createFile (const word &name) const
	Deprecated(2022-09) Return autoPtr to a new file using the simulation start time. More...

Static Protected Member Functions
template<class T >
static labelPair	findMinMax_mag (const UList< T > &input, label start=0)
	Return min/max indices base on the magnitude of the input. More...

Protected Attributes
bool	internal_
	Only use internal fields for the calculations. More...

bool	location_
	Flag to write location of min/max values. More...

modeType	mode_
	Mode for min/max - only applicable for ranks > 0. More...

volFieldSelection	fieldSet_
	Fields to assess min/max. 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...

Protected Attributes inherited from writeFile
const objectRegistry &	fileObr_
	Reference to the region objectRegistry. More...

const fileName	prefix_
	Prefix. More...

word	fileName_
	Name of file. More...

autoPtr< OFstream >	filePtr_
	File pointer. More...

label	writePrecision_
	Write precision. More...

bool	writeToFile_
	Flag to enable/disable writing to file. More...

bool	updateHeader_
	Flag to update the header, e.g. on mesh changes. Default is true. More...

bool	writtenHeader_
	Flag to identify whether the header has been written. More...

bool	useUserTime_
	Flag to use the specified user time, e.g. CA deg instead of seconds. Default = true. More...

scalar	startTime_
	Start time value. More...

string	ext_
	File extension; default = .dat. More...

Static Protected Attributes
static const Enum< modeType >	modeTypeNames_
	Mode 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...

Static Public Attributes inherited from writeFile
static label	addChars = 8
	Additional characters for writing. More...

Detailed Description

Computes the values and locations of field minima and maxima. These are good indicators of calculation performance, e.g. to confirm that predicted results are within expected bounds, or how well a case is converging.

Multiple fields can be processed, where for rank > 0 primitives, e.g. vectors and tensors, the extrema can be calculated per component, or by magnitude. In addition, spatial location and local processor index are included in the output.

Operands:

Operand	Type	Location
`input`	-	-
`output` file	dat	postProcessing/<FO>/<time>/file
`output` field	-	-

Usage

Minimal example by using system/controlDict.functions:

fieldMinMaxFO
{
    // Mandatory entries
    type        fieldMinMax;
    libs        (fieldFunctionObjects);
    mode        <word>;        // magnitude;
    fields      (<wordList>);  // (<field1> <field2> ... <fieldN>);

    // Optional entries
    location    <bool>;

    // Inherited entries
    ...
}

where the entries mean:

Property	Description	Type	Reqd	Deflt
`type`	Type name: fieldMinMax	word	yes	-
`libs`	Library name: fieldFunctionObjects	word	yes	-
`fields`	List of operand fields	wordList	yes	-
`location`	Write location of the min/max value	bool	no	true
`mode`	Calculation mode: magnitude or component	word	no	magnitude
`internal`	Internal fields only for the calculations	bool	no	false

The inherited entries are elaborated in:

Source files

Definition at line 167 of file fieldMinMax.H.

Member Typedef Documentation

◆ modeValueType_t

using modeValueType_t = typename modeValueType<T, Mode>::type

protected

Helper alias for modeValueType<T, Mode>::type.

Definition at line 206 of file fieldMinMax.H.

Member Enumeration Documentation

◆ modeType

enum modeType : char

strong

Options for the mode types.

Enumerator
mdMag	magnitude
mdCmpt	component

Definition at line 179 of file fieldMinMax.H.

Constructor & Destructor Documentation

◆ fieldMinMax() [1/2]

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

Construct from name, Time and dictionary.

◆ fieldMinMax() [2/2]

fieldMinMax ( const fieldMinMax & )

delete

No copy construct.

◆ ~fieldMinMax()

virtual ~fieldMinMax ( )

virtualdefault

Destructor.

Member Function Documentation

◆ findMinMax_mag()

static labelPair findMinMax_mag	(	const UList< T > &	input,
		label	start = `0`
	)

staticprotected

Return min/max indices base on the magnitude of the input.

This function should be migrated elsewhere.

◆ output()

void output	(	const word &	outputName,
		const label	minCell,
		const label	maxCell,
		const vector &	minC,
		const vector &	maxC,
		const label	minProci,
		const label	maxProci,
		const Type &	minValue,
		const Type &	maxValue
	)

protected

Helper function to write the output.

◆ writeFileHeader()

virtual void writeFileHeader ( Ostream & os )

protectedvirtual

Output file header information.

◆ calcMinMaxFieldType()

void calcMinMaxFieldType	(	const GeometricField< Type, fvPatchField, volMesh > &	field,
		const word &	outputFieldName
	)

protected

Calculate the field min/max for a given field type, optionally forcing mag vs component calculation.

◆ calcMinMaxFields()

bool calcMinMaxFields	(	const word &	fieldName,
		const modeType	mode
	)

protected

Calculate the field min/max.

◆ TypeName()

TypeName ( "fieldMinMax" )

Runtime type information.

◆ operator=()

void operator= ( const fieldMinMax & )

delete

No copy assignment.

◆ read()

virtual bool read ( const dictionary & dict )

virtual

Read the function-object dictionary.

Reimplemented from writeFile.

◆ execute()

virtual bool execute ( )

virtual

Execute the function-object operations.

Implements functionObject.

◆ write()

virtual bool write ( )

virtual

Write the function-object results.

Implements functionObject.

Member Data Documentation

◆ modeTypeNames_

const Enum<modeType> modeTypeNames_

staticprotected

Mode type names.

Definition at line 214 of file fieldMinMax.H.

◆ internal_

bool internal_

protected

Only use internal fields for the calculations.

Definition at line 219 of file fieldMinMax.H.

◆ location_

bool location_

protected

Flag to write location of min/max values.

Definition at line 224 of file fieldMinMax.H.

◆ mode_

modeType mode_

protected

Mode for min/max - only applicable for ranks > 0.

Definition at line 229 of file fieldMinMax.H.

◆ fieldSet_

volFieldSelection fieldSet_

protected

Fields to assess min/max.

Definition at line 234 of file fieldMinMax.H.

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

src/functionObjects/field/fieldMinMax/fieldMinMax.H

Classes

Public Types

Public Member Functions

Protected Types

Protected Member Functions

Static Protected Member Functions

Protected Attributes

Static Protected Attributes

Additional Inherited Members

Detailed Description

Member Typedef Documentation

◆ modeValueType_t

Member Enumeration Documentation

◆ modeType

Constructor & Destructor Documentation

◆ fieldMinMax() [1/2]

◆ fieldMinMax() [2/2]

◆ ~fieldMinMax()

Member Function Documentation

◆ findMinMax_mag()

◆ output()

◆ writeFileHeader()

◆ calcMinMaxFieldType()

◆ calcMinMaxFields()

◆ TypeName()

◆ operator=()

◆ read()

◆ execute()

◆ write()

Member Data Documentation

◆ modeTypeNames_

◆ internal_

◆ location_

◆ mode_

◆ fieldSet_