dsmcFields Class Reference

Calculate intensive fields: More...

Inheritance diagram for dsmcFields:
Collaboration diagram for dsmcFields:

Public Member Functions

 TypeName ("dsmcFields")
 Runtime type information. More...
 
 dsmcFields (const word &name, const Time &runTime, const dictionary &dict)
 Construct from Time and dictionary. More...
 
 dsmcFields (const dsmcFields &)=delete
 Disallow default bitwise copy construction. More...
 
virtual ~dsmcFields ()
 Destructor. More...
 
virtual bool read (const dictionary &)
 Read the dsmcFields data. More...
 
virtual wordList fields () const
 Return the list of fields required. More...
 
virtual bool executeAtStart () const
 Do not evaluate the state at the start of the run. More...
 
virtual bool execute ()
 Do nothing. More...
 
virtual bool write ()
 Calculate and write the DSMC fields. More...
 
void operator= (const dsmcFields &)=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 wordtype () 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< functionObjectclone () const
 Return clone. More...
 
 functionObject (const functionObject &)=delete
 Disallow default bitwise copy construction. More...
 
virtual ~functionObject ()
 Destructor. More...
 
const wordname () const
 Return the name of this functionObject. 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...
 

Additional Inherited Members

- Static Public Member Functions inherited from functionObject
static autoPtr< functionObjectNew (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...
 
- 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 Attributes inherited from fvMeshFunctionObject
const fvMeshmesh_
 Reference to the fvMesh. More...
 
- Protected Attributes inherited from regionFunctionObject
const objectRegistryobr_
 Reference to the region objectRegistry. More...
 
- Protected Attributes inherited from functionObject
const Timetime_
 Reference to time. More...
 

Detailed Description

Calculate intensive fields:

- UMean

  • translationalT
  • internalT
  • overallT from averaged extensive fields from a DSMC calculation.
See also
Foam::functionObjects::fvMeshFunctionObject
Source files

Definition at line 58 of file dsmcFields.H.

Constructor & Destructor Documentation

◆ dsmcFields() [1/2]

dsmcFields ( const word name,
const Time runTime,
const dictionary dict 
)

Construct from Time and dictionary.

Definition at line 55 of file dsmcFields.C.

References dict, and dsmcFields::read().

Here is the call graph for this function:

◆ dsmcFields() [2/2]

dsmcFields ( const dsmcFields )
delete

Disallow default bitwise copy construction.

◆ ~dsmcFields()

~dsmcFields ( )
virtual

Destructor.

Definition at line 70 of file dsmcFields.C.

Member Function Documentation

◆ TypeName()

TypeName ( "dsmcFields"  )

Runtime type information.

◆ read()

bool read ( const dictionary dict)
virtual

Read the dsmcFields data.

Reimplemented from regionFunctionObject.

Definition at line 76 of file dsmcFields.C.

Referenced by dsmcFields::dsmcFields().

Here is the caller graph for this function:

◆ fields()

Foam::wordList fields ( ) const
virtual

Return the list of fields required.

Implements functionObject.

Definition at line 82 of file dsmcFields.C.

◆ executeAtStart()

virtual bool executeAtStart ( ) const
inlinevirtual

Do not evaluate the state at the start of the run.

Reimplemented from functionObject.

Definition at line 95 of file dsmcFields.H.

◆ execute()

bool execute ( )
virtual

Do nothing.

Implements functionObject.

Definition at line 97 of file dsmcFields.C.

◆ write()

bool write ( )
virtual

Calculate and write the DSMC fields.

Implements functionObject.

Definition at line 103 of file dsmcFields.C.

References polyPatch::boundaryMesh(), Foam::endl(), polyPatch::faceAreas(), forAll, Foam::Info, k, Foam::mag(), polyPatch::magFaceAreas(), Foam::max(), Foam::min(), Foam::nl, IOobject::NO_READ, p, and regIOobject::write().

Here is the call graph for this function:

◆ operator=()

void operator= ( const dsmcFields )
delete

Disallow default bitwise assignment.


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