Writes out the initial residual for specified fields. More...

Inheritance diagram for residuals:

Collaboration diagram for residuals:

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

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

	residuals (const residuals &)=delete
	Disallow default bitwise copy construction. More...

virtual	~residuals ()
	Destructor. More...

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

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

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

void	operator= (const residuals &)=delete
	Disallow default bitwise assignment. 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...

	fvMeshFunctionObject (const fvMeshFunctionObject &)=delete
	Disallow default bitwise copy construction. More...

virtual	~fvMeshFunctionObject ()
	Destructor. More...

void	operator= (const fvMeshFunctionObject &)=delete
	Disallow default bitwise assignment. 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...

	regionFunctionObject (const regionFunctionObject &)=delete
	Disallow default bitwise copy construction. More...

virtual	~regionFunctionObject ()
	Destructor. More...

void	operator= (const regionFunctionObject &)=delete
	Disallow default bitwise assignment. More...

Public Member Functions inherited from functionObject
	ClassName ("functionObject")

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

	declareRunTimeSelectionTable (autoPtr, functionObject, dictionary,(const word &name, const Time &runTime, const dictionary &dict),(name, runTime, dict))

	functionObject (const word &name)
	Construct from components. More...

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

	functionObject (const functionObject &)=delete
	Disallow default bitwise copy construction. More...

virtual	~functionObject ()
	Destructor. More...

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

virtual bool	executeAtStart () const
	Return true if the functionObject should be executed at the start. More...

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

virtual scalar	timeToNextWrite ()
	Called by Time::adjustTimeStep(). Allows the functionObject to. 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...

void	operator= (const functionObject &)=delete
	Disallow default bitwise assignment. More...

Public Member Functions inherited from logFiles
	logFiles (const objectRegistry &obr, const word &prefix)
	Construct from objectRegistry and prefix. More...

	logFiles (const logFiles &)=delete
	Disallow default bitwise copy construction. More...

virtual	~logFiles ()
	Destructor. More...

const wordList &	names () const
	Return const access to the names. More...

PtrList< OFstream > &	files ()
	Return access to the files. More...

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

OFstream &	file (const label i)
	Return file 'i'. More...

void	operator= (const logFiles &)=delete
	Disallow default bitwise assignment. More...

Public Member Functions inherited from writeFile
	writeFile (const objectRegistry &obr, const word &prefix)
	Construct from objectRegistry and prefix. More...

	writeFile (const writeFile &)=delete
	Disallow default bitwise copy construction. More...

	~writeFile ()
	Destructor. More...

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

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

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

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

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

void	writeTime (Ostream &os) const
	Write the current time to 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...

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

void	operator= (const writeFile &)=delete
	Disallow default bitwise assignment. More...

Protected Member Functions
template<class Type >
void	writeFileHeader (const word &fieldName)
	Output field header information. More...

virtual void	writeFileHeader (const label i)
	Output file header information. More...

template<class Type >
void	writeResidual (const word &fieldName)
	Calculate the field min/max. More...

Protected Member Functions inherited from regionFunctionObject
template<class ObjectType >
bool	foundObject (const word &fieldName) const
	Find field in the objectRegistry. More...

template<class ObjectType >
void	cannotFindObject (const word &fieldName)
	Prints a warning message that fieldName cannot be found. More...

void	cannotFindObject (const word &fieldName)
	Prints a warning message that fieldName cannot be found. More...

template<class ObjectType >
const ObjectType &	lookupObject (const word &fieldName) const
	Lookup object from the objectRegistry. More...

template<class ObjectType >
ObjectType &	lookupObjectRef (const word &fieldName)
	Lookup non-const object reference from the objectRegistry. More...

template<class ObjectType >
bool	store (const tmp< ObjectType > &tfield)
	Store the given field in the objectRegistry. More...

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

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

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

Protected Member Functions inherited from logFiles
virtual void	createFiles ()
	Create the output file. More...

virtual void	resetNames (const wordList &names)
	Reset the list of names from a wordList. More...

virtual void	resetName (const word &name)
	Reset the list of names to a single name entry. More...

Protected Attributes
wordList	fieldSet_
	Fields to write residuals. More...

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

Protected Attributes inherited from regionFunctionObject
const Time &	time_
	Reference to the Time. More...

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

Protected Attributes inherited from logFiles
wordList	names_
	File names. More...

PtrList< OFstream >	filePtrs_
	File pointer. More...

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

const word	prefix_
	Prefix. More...

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

Public Attributes inherited from functionObject
Switch	log
	Switch write log to Info. More...

Switch	executeAtStart_
	Switch write log to Info. More...

Static Public Attributes inherited from functionObject
static bool	postProcess
	Global post-processing mode switch. More...

Static Public Attributes inherited from writeFile
static const word	outputPrefix
	Directory prefix. More...

static label	addChars = 8
	Additional characters for writing. More...

Detailed Description

Writes out the initial residual for specified fields.

Example of function object specification:

residuals
{
    type            residuals;
    writeControl   timeStep;
    writeInterval  1;
    fields
    (
        U
        p
    );
}

Output data is written to the dir postProcessing/residuals/<timeDir>/ For vector/tensor fields, e.g. U, where an equation is solved for each component, the largest residual of each component is written out.

See also: Foam::functionObject Foam::functionObjects::fvMeshFunctionObject Foam::functionObjects::logFiles Foam::functionObjects::timeControl

Source files

Definition at line 76 of file residuals.H.

Constructor & Destructor Documentation

◆ residuals() [1/2]

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

Construct from Time and dictionary.

Definition at line 50 of file residuals.C.

References Foam::read().

Here is the call graph for this function:

◆ residuals() [2/2]

residuals ( const residuals & )

delete

Disallow default bitwise copy construction.

◆ ~residuals()

~residuals ( )

virtual

Destructor.

Definition at line 66 of file residuals.C.

Member Function Documentation

◆ writeFileHeader() [1/2]

void writeFileHeader ( const word & fieldName )

protected

Output field header information.

Definition at line 34 of file residualsTemplates.C.

References Foam::component(), logFiles::file(), objectRegistry::foundObject(), fvMeshFunctionObject::mesh_, regionFunctionObject::obr_, fvMesh::validComponents(), and writeFile::writeTabbed().

Here is the call graph for this function:

◆ writeFileHeader() [2/2]

void writeFileHeader ( const label i )

protectedvirtual

Output file header information.

Implements logFiles.

Definition at line 84 of file residuals.C.

References Foam::endl(), Foam::file, forAll, UPstream::master(), and Foam::vtkWriteOps::writeHeader().

Here is the call graph for this function:

◆ writeResidual()

void writeResidual ( const word & fieldName )

protected

Calculate the field min/max.

Definition at line 61 of file residualsTemplates.C.

References Foam::component(), logFiles::file(), UList< T >::first(), objectRegistry::foundObject(), fvMeshFunctionObject::mesh_, regionFunctionObject::obr_, Foam::tab, and fvMesh::validComponents().

Here is the call graph for this function:

◆ TypeName()

TypeName ( "residuals" )

Runtime type information.

◆ read()

bool read ( const dictionary & dict )

virtual

Read the controls.

Reimplemented from regionFunctionObject.

Definition at line 72 of file residuals.C.

References dictionary::lookup(), and regionFunctionObject::read().

Here is the call graph for this function:

◆ execute()

bool execute ( )

virtual

Execute, currently does nothing.

Implements functionObject.

Definition at line 107 of file residuals.C.

◆ write()

bool write ( )

virtual

Write the residuals.

Reimplemented from logFiles.

Definition at line 113 of file residuals.C.

References Foam::endl(), Foam::file, forAll, UPstream::master(), and logFiles::write().

Here is the call graph for this function:

◆ operator=()

void operator= ( const residuals & )

delete

Disallow default bitwise assignment.

Member Data Documentation

◆ fieldSet_

wordList fieldSet_

protected

Fields to write residuals.

Definition at line 86 of file residuals.H.

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

src/functionObjects/utilities/residuals/residuals.H
src/functionObjects/utilities/residuals/residuals.C
src/functionObjects/utilities/residuals/residualsTemplates.C

Public Member Functions

Protected Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ residuals() [1/2]

◆ residuals() [2/2]

◆ ~residuals()

Member Function Documentation

◆ writeFileHeader() [1/2]

◆ writeFileHeader() [2/2]

◆ writeResidual()

◆ TypeName()

◆ read()

◆ execute()

◆ write()

◆ operator=()

Member Data Documentation

◆ fieldSet_