This functionObject writes cloud(s) in ensight format. More...

#include <ensightCloudWriteObject.H>

Inheritance diagram for ensightCloudWriteObject:

[legend]

Collaboration diagram for ensightCloudWriteObject:

[legend]

Public Member Functions
	TypeName ("ensightCloud")
	Runtime type information.
	ensightCloudWriteObject (const word &name, const Time &runTime, const dictionary &dict)
	Construct from name, Time and dictionary.
virtual	~ensightCloudWriteObject ()=default
	Destructor.
virtual bool	read (const dictionary &dict)
	Read the ensightCloud specification.
virtual bool	execute ()
	Execute, currently does nothing.
virtual bool	write ()
	Write fields.
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 parcelSelection
	parcelSelection ()=default
	Default construct.
virtual	~parcelSelection ()=default
	Destructor.

Additional Inherited Members
Public Types inherited from parcelSelection
enum	actionType { ALL , CLEAR , INVERT , ADD , SUBTRACT , SUBSET , USE , IGNORE }
	Enumeration defining the valid selection actions. More...
enum	sourceType { FIELD , STRIDE }
	Enumeration defining the valid sources. More...
enum	logicType { AND , OR }
	Enumeration defining and/or logic. More...
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 parcelSelection
static const Enum< actionType >	actionNames
	Names for the actionType.
static const Enum< sourceType >	sourceNames
	Names for the sourceType.
static const Enum< logicType >	logicNames
	Names for the logicType.
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 parcelSelection
bool	calculateFilter (const objectRegistry &obrTmp, const bool log=true)
	Calculate parcel selection filter.
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 parcelSelection
dictionary	parcelSelect_
	The filtered parcel addressing. Eg, for the current cloud.
bitSet	parcelAddr_
	The filtered parcel addressing. Eg, for the current cloud.

Detailed Description

This functionObject writes cloud(s) in ensight format.

Example of function object specification:

cloudWrite1
{
    type            ensightCloud;
    libs            (lagrangianFunctionObjects);
    writeControl    writeTime;
    writeInterval   1;
    format          ascii;

    timeFormat      scientific;
    timePrecision   5;

    cloud           myCloud;
    fields          (T U rho);
    width           4;  // file-padding

    selection
    {
        stride
        {
            // every 10th parcelId
            action  add;
            source  stride;
            stride  10;
        }
        Umin
        {
            // Remove slow parcels
            action  subtract;
            source  field;
            field   U;
            accept  (less 1e-3);
        }
        diam
        {
            // Only particular diameter ranges
            action  subset;
            source  field;
            field   d;
            accept  (greater 1e-3) and (less 1e-3);
        }
    }
}

Basic Usage

Property	Description	Required	Default
`type`	Type name: ensightCloud	yes
`clouds`	List of clouds (name or regex)	no
`cloud`	Cloud name	no
`fields`	List of fields (name or regex)	no
`selection`	Parcel selection control	no	empty-dict

Output Options

Property	Description	Required	Default
`format`	Format as ascii or binary	no	binary
`width`	Mask width for `data/XXXX`	no	8
`directory`	The output directory name	no	postProcessing/NAME
`overwrite`	Remove existing directory	no	false
`consecutive`	Consecutive output numbering	no	false
`width`	Padding width for file name	no	8
`prune`	Suppress writing of empty clouds	no	false
`timeFormat`	Time format (ensight case)	no	scientific
`timePrecision`	Time precision (ensight case)	no	5
`writeControl`	Output control	recommended	timeStep

The output filename and fields are added to the functionObjectProperties information. For the previous example specification:

    cloudWrite1
    {
        myCloud
        {
            file    "<case>/simulation.case";
            fields  (T U rho);
        }
    }

Note: The selection dictionary can be used for finer control of the parcel output. It contains a set of (add,subtract,subset,clear,invert) selection actions and sources. Omitting the selection dictionary is the same as specifying the conversion of all parcels (in the selected clouds). More syntax details are to be found in the corresponding Foam::Detail::parcelSelection class.

See also: Foam::Detail::parcelSelection Foam::functionObjects::vtkCloud Foam::functionObjects::ensightWrite Foam::functionObjects::fvMeshFunctionObject Foam::functionObjects::timeControl

Source files

Definition at line 242 of file ensightCloudWriteObject.H.

Constructor & Destructor Documentation

◆ ensightCloudWriteObject()

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

Construct from name, Time and dictionary.

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

Here is the call graph for this function:

◆ ~ensightCloudWriteObject()

virtual ~ensightCloudWriteObject ( )

virtualdefault

Destructor.

Member Function Documentation

◆ TypeName()

TypeName ( "ensightCloud" )

Runtime type information.

◆ read()

virtual bool read ( const dictionary & dict )

virtual

Read the ensightCloud specification.

Reimplemented from regionFunctionObject.

References dict.

◆ execute()

virtual bool execute ( )

virtual

Execute, currently does nothing.

Implements functionObject.

◆ write()

virtual bool write ( )

virtual

Write fields.

Implements functionObject.

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

src/functionObjects/lagrangian/ensightCloud/ensightCloudWriteObject.H

Public Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ ensightCloudWriteObject()

◆ ~ensightCloudWriteObject()

Member Function Documentation

◆ TypeName()

◆ read()

◆ execute()

◆ write()