Function to log a single reduced quantity generated from the values in a Lagrangian field; e.g., sums, averages, maximums and minimums. More...

Inheritance diagram for LagrangianFieldValue:

[legend]

Collaboration diagram for LagrangianFieldValue:

[legend]

Public Types
enum class	operationType { sum , average , min , max , minMag , maxMag }
	Operation type enumeration. More...

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

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

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

virtual	~LagrangianFieldValue ()
	Destructor. More...

virtual bool	read (const dictionary &)
	Read parameters. More...

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

virtual bool	execute ()
	Execute. Does nothing. More...

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

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

Public Member Functions inherited from LagrangianMeshFunctionObject
	TypeName ("LagrangianMeshFunctionObject")
	Runtime type information. More...

	LagrangianMeshFunctionObject (const word &name, const Time &runTime, const dictionary &dict, const word &LagrangianKeyword="Lagrangian")
	Construct from Time and dictionary. More...

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

virtual	~LagrangianMeshFunctionObject ()
	Destructor. More...

const LagrangianMesh &	mesh () const
	Access the mesh. More...

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

Public Member Functions inherited from objectRegistryFunctionObject
	TypeName ("objectRegistryFunctionObject")
	Runtime type information. More...

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

	objectRegistryFunctionObject (const word &name, const objectRegistry &obr)
	Construct from an objectRegistry. More...

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

virtual	~objectRegistryFunctionObject ()
	Destructor. More...

void	operator= (const objectRegistryFunctionObject &)=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...

	functionObject (const word &name, const Time &runTime, const dictionary &dict)
	Construct from dictionary. 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 scalar	maxDeltaT () const
	Return the maximum time-step for stable operation. 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 &	toc () const
	Return the list of log file names. More...

const wordList &	names () const
	Return the list of log file 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 Attributes
static const NamedEnum< operationType, 6 >	operationTypeNames_ {"sum", "average", "min", "max", "minMag", "maxMag"}
	Operation type names. 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...

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 execute at start time. More...

Protected Member Functions inherited from objectRegistryFunctionObject
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...

void	cannotFindObjects (const wordList &fieldNames)
	Prints a warning message that fieldNames 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 >
ObjectType &	store (const tmp< ObjectType > &tfield)
	Store the given field in the objectRegistry. More...

template<class ObjectType >
ObjectType &	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 inherited from objectRegistryFunctionObject
const objectRegistry &	obr_
	Reference to the 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...

Detailed Description

Function to log a single reduced quantity generated from the values in a Lagrangian field; e.g., sums, averages, maximums and minimums.

Usage

Property	Description	Required?	Default
`Lagrangian`	Name of the Lagrangian mesh	yes
`field`	Field to operate on	if fields not specified
`fields`	List of fields to operate on	if field not specified
`weightField`	Field with which to weight the distribution	no	none
`weightFields`	List of fields with which to </td>
`weight` the distribution	no	none
`operation`	The operation with which to </td>
`combine` Lagrangian values	yes
`writeLocation`	Whether or not to write the location	no	false

Where operation is one of

sum	:	Sum
average	:	Ensemble average
min	:	Minimum (component minimum if a higher rank type)
max	:	Maximum (component maximum if a higher rank type)
minMag	:	Minimum magnitude
maxMag	:	Maximum magnitude

Example specification to generate the total mass:

    LagrangianFieldValue1
    {
        type            LagrangianFieldValue;
        libs            ("libLagrangianFunctionObjects.so");
        Lagrangian      cloud;
        field           m;
        weightField     number;
    }

Source files

Definition at line 157 of file LagrangianFieldValue.H.

Member Enumeration Documentation

◆ operationType

enum operationType

strong

Operation type enumeration.

Enumerator
sum
average
min
max
minMag
maxMag

Definition at line 167 of file LagrangianFieldValue.H.

Constructor & Destructor Documentation

◆ LagrangianFieldValue() [1/2]

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

Construct from Time and dictionary.

Definition at line 496 of file LagrangianFieldValue.C.

References dict.

◆ LagrangianFieldValue() [2/2]

LagrangianFieldValue ( const LagrangianFieldValue & )

delete

Disallow default bitwise copy construction.

◆ ~LagrangianFieldValue()

~LagrangianFieldValue ( )

virtual

Destructor.

Definition at line 516 of file LagrangianFieldValue.C.

Member Function Documentation

◆ TypeName()

TypeName ( "LagrangianFieldValue" )

Runtime type information.

◆ read()

bool read ( const dictionary & dict )

virtual

Read parameters.

Reimplemented from objectRegistryFunctionObject.

Definition at line 522 of file LagrangianFieldValue.C.

References dict, and objectRegistryFunctionObject::read().

Here is the call graph for this function:

◆ fields()

Foam::wordList fields ( ) const

virtual

Return the list of fields required.

Implements functionObject.

Definition at line 536 of file LagrangianFieldValue.C.

References List< T >::append().

Here is the call graph for this function:

◆ execute()

bool execute ( )

virtual

Execute. Does nothing.

Implements functionObject.

Definition at line 544 of file LagrangianFieldValue.C.

◆ write()

bool write ( )

virtual

Write the sum.

Reimplemented from logFiles.

Definition at line 550 of file LagrangianFieldValue.C.

References Foam::fvc::average(), Foam::exit(), Foam::FatalError, FatalErrorInFunction, Foam::file, Foam::FOR_ALL_FIELD_TYPES(), forAll, UPstream::master(), Foam::max(), mesh, Foam::min(), Foam::returnReduce(), Foam::sum(), logFiles::write(), and WRITE_FIELD_VALUE.

Here is the call graph for this function:

◆ operator=()

void operator= ( const LagrangianFieldValue & )

delete

Disallow default bitwise assignment.

Member Data Documentation

◆ operationTypeNames_

const Foam::NamedEnum< Foam::functionObjects::LagrangianFieldValue::operationType, 6 > operationTypeNames_ {"sum", "average", "min", "max", "minMag", "maxMag"}

static

Operation type names.

Definition at line 178 of file LagrangianFieldValue.H.

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

src/Lagrangian/LagrangianFunctionObjects/LagrangianFieldValue/LagrangianFieldValue.H
src/Lagrangian/LagrangianFunctionObjects/LagrangianFieldValue/LagrangianFieldValue.C

Public Types

Public Member Functions

Static Public Attributes

Additional Inherited Members

Detailed Description

Member Enumeration Documentation

◆ operationType

Constructor & Destructor Documentation

◆ LagrangianFieldValue() [1/2]

◆ LagrangianFieldValue() [2/2]

◆ ~LagrangianFieldValue()

Member Function Documentation

◆ TypeName()

◆ read()

◆ fields()

◆ execute()

◆ write()

◆ operator=()

Member Data Documentation

◆ operationTypeNames_