Base class for field value -based function objects. More...

Inheritance diagram for fieldValue:

[legend]

Collaboration diagram for fieldValue:

[legend]

Public Member Functions
	TypeName ("fieldValue")
	Run-time type information. More...

	declareRunTimeSelectionTable (autoPtr, fieldValue, dictionary,(const word &name, const objectRegistry &obr, const dictionary &dict),(name, obr, dict))

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

	fieldValue (const word &name, const objectRegistry &obr, const dictionary &dict, const word &valueType)
	Construct from objectRegistry and dictionary. More...

virtual	~fieldValue ()
	Destructor. More...

const dictionary &	dict () const
	Return the reference to the construction dictionary. More...

virtual wordList	fields () const
	Return the list of fields required. More...

const Switch &	writeFields () const
	Return the output field values flag. More...

const dictionary &	resultDict () const
	Return access to the latest set of results. More...

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

virtual bool	execute ()
	Execute. More...

virtual bool	write ()
	Write. 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, const Time &runTime)
	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	timeToNextAction ()
	Called by Time::adjustTimeStep(). Allows the functionObject to. More...

virtual void	movePoints (const polyMesh &mesh)
	Update topology using the given map. More...

virtual void	topoChange (const polyTopoChangeMap &map)
	Update topology using the given map. More...

virtual void	mapMesh (const polyMeshMap &)
	Update from another mesh using the given map. More...

virtual void	distribute (const polyDistributionMap &)
	Redistribute or update using the given distribution map. 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...

Static Public Member Functions
static autoPtr< fieldValue >	New (const word &name, const objectRegistry &obr, const dictionary &dict, const bool output=true)
	Return a reference to the selected fieldValue. More...

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

Protected Member Functions
template<class Type >
void	combineFields (Field< Type > &field)
	Combine fields from all processor domains into single field. More...

template<class Type >
void	combineFields (tmp< Field< Type >> &)
	Combine fields from all processor domains into single field. 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...

virtual void	writeFileHeader (const label i=0)=0
	File header information. More...

Protected Attributes
dictionary	dict_
	Construction dictionary. More...

const word	valueType_
	The name of the type of value (volFieldValue, or surfaceFieldValue) More...

wordList	fields_
	List of field names to operate on. More...

Switch	writeFields_
	Output field values flag. More...

dictionary	resultDict_
	Results dictionary for external access of results. More...

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

Protected Attributes inherited from regionFunctionObject
const objectRegistry &	obr_
	Reference to the region objectRegistry. More...

Protected Attributes inherited from functionObject
const Time &	time_
	Reference to time. 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
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

Base class for field value -based function objects.

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

Source files

Definition at line 62 of file fieldValue.H.

Constructor & Destructor Documentation

◆ fieldValue() [1/2]

fieldValue	(	const word &	name,
		const Time &	runTime,
		const dictionary &	dict,
		const word &	valueType
	)

Construct from Time and dictionary.

Definition at line 44 of file fieldValue.C.

References fieldValue::dict(), and fieldValue::read().

Here is the call graph for this function:

◆ fieldValue() [2/2]

fieldValue	(	const word &	name,
		const objectRegistry &	obr,
		const dictionary &	dict,
		const word &	valueType
	)

Construct from objectRegistry and dictionary.

Definition at line 62 of file fieldValue.C.

References fieldValue::dict(), and fieldValue::read().

Here is the call graph for this function:

◆ ~fieldValue()

~fieldValue ( )

virtual

Destructor.

Definition at line 82 of file fieldValue.C.

Member Function Documentation

◆ combineFields() [1/2]

void combineFields ( Field< Type > & field )

protected

Combine fields from all processor domains into single field.

Definition at line 33 of file fieldValueTemplates.C.

References Pstream::gatherList(), UPstream::master(), UPstream::myProcNo(), and UPstream::nProcs().

Here is the call graph for this function:

◆ combineFields() [2/2]

void combineFields ( tmp< Field< Type >> & field )

protected

Combine fields from all processor domains into single field.

Definition at line 54 of file fieldValueTemplates.C.

◆ TypeName()

TypeName ( "fieldValue" )

Run-time type information.

◆ declareRunTimeSelectionTable()

declareRunTimeSelectionTable	(	autoPtr	,
		fieldValue	,
		dictionary	,
		(const word &name, const objectRegistry &obr, const dictionary &dict)	,
		(name, obr, dict)
	)

◆ New()

Foam::autoPtr< Foam::functionObjects::fieldValue > New	(	const word &	name,
		const objectRegistry &	obr,
		const dictionary &	dict,
		const bool	output = `true`
	)