Writes solver information for a list of user-specified fields. More...

#include <solverInfo.H>

Inheritance diagram for solverInfo:

[legend]

Collaboration diagram for solverInfo:

[legend]

Public Member Functions
	TypeName ("solverInfo")
	Runtime type information.
	solverInfo (const word &name, const Time &runTime, const dictionary &dict)
	Construct from name, Time and dictionary.
virtual	~solverInfo ()=default
	Destructor.
virtual bool	read (const dictionary &)
	Read the function-object dictionary.
virtual bool	execute ()
	Execute the function-object operations.
virtual bool	write ()
	Write the function-object results (no-op).
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.
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.
	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.
	writeFile (const writeFile &wf)
	Construct copy.
virtual	~writeFile ()=default
	Destructor.
virtual const string &	setExt (const string &ext)
	Set extension.
virtual OFstream &	file ()
	Return access to the file (if only 1).
virtual bool	writeToFile () const
	Flag to allow writing to file.
virtual bool	canWriteToFile () const
	Flag to allow writing to the file.
virtual bool	canResetFile () const
	Flag to allow resetting the file.
virtual bool	canWriteHeader () const
	Flag to allow writing the header.
virtual label	charWidth () const
	Return width of character stream output.
virtual void	writeCommented (Ostream &os, const string &str) const
	Write a commented string to stream.
virtual void	writeTabbed (Ostream &os, const string &str) const
	Write a tabbed string to stream.
virtual void	writeHeader (Ostream &os, const string &str) const
	Write a commented header to stream.
virtual void	writeCurrentTime (Ostream &os) const
	Write the current time to stream.
virtual void	writeBreak (Ostream &os) const
	Write a break marker to the stream.
template<class Type>
void	writeHeaderValue (Ostream &os, const string &property, const Type &value) const
	Write a (commented) header property and value pair.
template<class Type>
void	writeValue (Ostream &os, const Type &val) const
	Write a given value to stream with the space delimiter.

Protected Member Functions
void	writeFileHeader (Ostream &os)
	Output file header information.
void	createResidualField (const word &fieldName)
	Create and store a residual field on the mesh database.
template<class Type>
void	writeFileHeader (Ostream &os, const word &fileName) const
	Output file header information per primitive type value.
template<class Type>
void	initialiseResidualField (const word &fieldName)
	Initialise a residual field.
template<class Type>
void	updateSolverInfo (const word &fieldName)
	Calculate the solver information.
	solverInfo (const solverInfo &)=delete
	No copy construct.
void	operator= (const solverInfo &)=delete
	No copy assignment.
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 Member Functions inherited from writeFile
void	initStream (Ostream &os) const
	Initialise the output stream for writing.
fileName	baseFileDir () const
	Return the base directory for output.
fileName	baseTimeDir () const
	Return the base directory for the current time value.
fileName	filePath (const fileName &fName) const
	Return the full path for the supplied file name.
virtual autoPtr< OFstream >	newFile (const fileName &fName) const
	Return autoPtr to a new file using file name.
virtual autoPtr< OFstream >	newFileAtTime (const word &name, scalar timeValue) const
	Return autoPtr to a new file for a given time.
virtual autoPtr< OFstream >	newFileAtStartTime (const word &name) const
	Return autoPtr to a new file using the simulation start time.
virtual void	resetFile (const word &name)
	Reset internal file pointer to new file with new name.
Omanip< int >	valueWidth (const label offset=0) const
	Return the value width when writing to stream with optional offset.
void	operator= (const writeFile &)=delete
	No copy assignment.
virtual autoPtr< OFstream >	createFile (const word &name, scalar timeValue) const
	Deprecated(2022-09) Return autoPtr to a new file for a given time.
virtual autoPtr< OFstream >	createFile (const word &name) const
	Deprecated(2022-09) Return autoPtr to a new file using the simulation start time.

Protected Attributes
solverFieldSelection	fieldSet_
	Names of operand fields.
wordHashSet	residualFieldNames_
	Names of (result) residual fields.
bool	writeResidualFields_
	Flag to write the initial-residual as a vol field.
bool	initialised_
	Initialisation flag.
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.
Protected Attributes inherited from writeFile
const objectRegistry &	fileObr_
	Reference to the region objectRegistry.
const fileName	prefix_
	Prefix.
word	fileName_
	Name of file.
autoPtr< OFstream >	filePtr_
	File pointer.
label	writePrecision_
	Write precision.
bool	writeToFile_
	Flag to enable/disable writing to file.
bool	updateHeader_
	Flag to update the header, e.g. on mesh changes. Default is true.
bool	writtenHeader_
	Flag to identify whether the header has been written.
bool	useUserTime_
	Flag to use the specified user time, e.g. CA deg instead of seconds. Default = true.
scalar	startTime_
	Start time value.
string	ext_
	File extension; default = .dat.

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.
Static Public Attributes inherited from writeFile
static label	addChars = 8
	Additional characters for writing.

Detailed Description

Writes solver information for a list of user-specified fields.

Information written to file includes:

residual fields
solver type
initial residual
final residual
number of solver iterations
convergence flag

Operands:

Operand	Type	Location
`input`	-	-
`output` file	dat	postProcessing/<FO>/<time>/<file>(s)
`output` field	volScalarField(s)	<time>/initialResiduals:<outField>(s)

Usage

Minimal example by using system/controlDict.functions:

solverInfoFO
{
    // Mandatory entries
    type            solverInfo;
    libs            (utilityFunctionObjects);
    fields          <wordList>;  // (<field1> <field2> ... <fieldN>);

    // Optional entries
    writeResidualFields <bool>;

    // Inherited entries
    ...
}

where the entries mean:

Property	Description	Type	Reqd	Deflt
`type`	Type name: solverInfo	word	yes	-
`libs`	Library name: utilityFunctionObjects	word	yes	-
`fields`	Names of operand fields	wordList	yes	-
`writeResidualFields`	Flag to write the initial-residual fields	bool	no	false

The inherited entries are elaborated in:

Source files

Definition at line 151 of file solverInfo.H.

Constructor & Destructor Documentation

◆ solverInfo() [1/2]

solverInfo ( const solverInfo & )

protecteddelete

No copy construct.

References solverInfo().

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

Here is the call graph for this function:

Here is the caller graph for this function:

◆ solverInfo() [2/2]

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

Construct from name, Time and dictionary.

Definition at line 115 of file solverInfo.C.

References dict, fieldSet_, fvMeshFunctionObject::fvMeshFunctionObject(), Foam::GlobalIOList< Tuple2< scalar, vector > >::typeName, initialised_, fvMeshFunctionObject::mesh_, Foam::name(), regionFunctionObject::obr_, read(), residualFieldNames_, runTime, writeFile::writeFile(), and writeResidualFields_.

Here is the call graph for this function:

◆ ~solverInfo()

virtual ~solverInfo ( )

virtualdefault

Destructor.

Member Function Documentation

◆ writeFileHeader() [1/2]

void writeFileHeader ( Ostream & os )

protected

Output file header information.

Definition at line 39 of file solverInfo.C.

References Foam::endl(), fieldSet_, writeFile::file(), os(), writeFile::writeBreak(), writeFile::writeCommented(), writeFileHeader(), writeFile::writeHeader(), and writeFile::writtenHeader_.

Referenced by execute(), and writeFileHeader().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ createResidualField()

void createResidualField ( const word & fieldName )

protected

Create and store a residual field on the mesh database.

Definition at line 72 of file solverInfo.C.

References fvMeshFunctionObject::mesh_, IOobjectOption::NO_READ, IOobjectOption::NO_WRITE, IOobjectOption::REGISTER, residualFieldNames_, IOobject::scopedName(), writeResidualFields_, and Foam::Zero.

Referenced by initialiseResidualField().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ writeFileHeader() [2/2]

template<class Type>

void writeFileHeader	(	Ostream &	os,
		const word &	fileName ) const

protected

Output file header information per primitive type value.

Definition at line 30 of file solverInfoTemplates.C.

References Foam::component(), regionFunctionObject::foundObject(), fvMeshFunctionObject::mesh_, os(), and writeFile::writeTabbed().

Here is the call graph for this function:

◆ initialiseResidualField()

template<class Type>

void initialiseResidualField ( const word & fieldName )

protected

Initialise a residual field.

Definition at line 66 of file solverInfoTemplates.C.

References Foam::component(), createResidualField(), dictionary::found(), regionFunctionObject::foundObject(), and fvMeshFunctionObject::mesh_.

Referenced by execute().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ updateSolverInfo()

template<class Type>

void updateSolverInfo ( const word & fieldName )

protected

Calculate the solver information.

Definition at line 103 of file solverInfoTemplates.C.

References Foam::component(), SolverPerformance< Type >::converged(), writeFile::file(), SolverPerformance< Type >::finalResidual(), Pair< T >::first(), dictionary::found(), regionFunctionObject::foundObject(), SolverPerformance< Type >::initialResidual(), dictionary::lookup(), fvMeshFunctionObject::mesh_, n, SolverPerformance< Type >::nIterations(), stateFunctionObject::setResult(), SolverPerformance< Type >::solverName(), and token::TAB.

Referenced by execute().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ operator=()

void operator= ( const solverInfo & )

protecteddelete

No copy assignment.

References solverInfo().

Here is the call graph for this function:

◆ TypeName()

TypeName ( "solverInfo" )

Runtime type information.

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

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 135 of file solverInfo.C.

References dict, fieldSet_, initialised_, functionObject::read(), residualFieldNames_, and writeResidualFields_.

Referenced by solverInfo().

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 154 of file solverInfo.C.

References Foam::endl(), fieldSet_, writeFile::file(), initialised_, initialiseResidualField(), updateSolverInfo(), writeFile::writeCurrentTime(), writeFileHeader(), and writeResidualFields_.

Here is the call graph for this function:

◆ write()

bool write ( )

virtual

Write the function-object results (no-op).

Implements functionObject.

Definition at line 194 of file solverInfo.C.

References GeometricField< Type, PatchField, GeoMesh >::correctBoundaryConditions(), Foam::dimless, fvMeshFunctionObject::mesh_, IOobjectOption::NO_READ, IOobjectOption::NO_REGISTER, IOobjectOption::NO_WRITE, GeometricField< Type, PatchField, GeoMesh >::primitiveFieldRef(), residualFieldNames_, regIOobject::write(), Foam::Zero, and fvPatchFieldBase::zeroGradientType().

Here is the call graph for this function:

Member Data Documentation

◆ fieldSet_

solverFieldSelection fieldSet_

protected

Names of operand fields.

Definition at line 163 of file solverInfo.H.

Referenced by execute(), read(), solverInfo(), and writeFileHeader().

◆ residualFieldNames_

wordHashSet residualFieldNames_

protected

Names of (result) residual fields.

Definition at line 168 of file solverInfo.H.

Referenced by createResidualField(), read(), solverInfo(), and write().

◆ writeResidualFields_

bool writeResidualFields_

protected

Flag to write the initial-residual as a vol field.

Definition at line 173 of file solverInfo.H.

Referenced by createResidualField(), execute(), read(), and solverInfo().

◆ initialised_

bool initialised_

protected

Initialisation flag.

Definition at line 178 of file solverInfo.H.

Referenced by execute(), read(), and solverInfo().

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

src/functionObjects/utilities/solverInfo/solverInfo.H
src/functionObjects/utilities/solverInfo/solverInfo.C
src/functionObjects/utilities/solverInfo/solverInfoTemplates.C

Public Member Functions

Protected Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ solverInfo() [1/2]

◆ solverInfo() [2/2]

◆ ~solverInfo()

Member Function Documentation

◆ writeFileHeader() [1/2]

◆ createResidualField()

◆ writeFileHeader() [2/2]

◆ initialiseResidualField()

◆ updateSolverInfo()

◆ operator=()

◆ TypeName()

◆ read()

◆ execute()

◆ write()

Member Data Documentation

◆ fieldSet_

◆ residualFieldNames_

◆ writeResidualFields_

◆ initialised_