Writes the domain averaged reaction rates for each specie for each reaction into the file <timeDir>/specieReactionRates.dat. More...
Public Member Functions | |
| TypeName ("specieReactionRates") | |
| Runtime type information. More... | |
| specieReactionRates (const word &name, const Time &runTime, const dictionary &dict) | |
| Construct from Time and dictionary. More... | |
| specieReactionRates (const specieReactionRates &)=delete | |
| Disallow default bitwise copy construction. More... | |
| virtual | ~specieReactionRates () |
| Destructor. More... | |
| virtual bool | read (const dictionary &) |
| Read the specieReactionRates data. More... | |
| virtual wordList | fields () const |
| Return the list of fields required. More... | |
| virtual bool | execute () |
| Do nothing. More... | |
| virtual bool | write () |
| Write the specie reaction rates. More... | |
| void | operator= (const specieReactionRates &)=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, 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 fvCellSet | |
| fvCellSet (const fvMesh &mesh) | |
| Construct from mesh. Will select all. More... | |
| fvCellSet (const fvMesh &mesh, const dictionary &dict) | |
| Construct from mesh and dictionary. More... | |
| ~fvCellSet () | |
| Destructor. More... | |
| scalar | V () const |
| Return const access to the total cell volume. More... | |
| void | movePoints () |
| Update for mesh motion. More... | |
| void | topoChange (const polyTopoChangeMap &) |
| Update topology using the given map. More... | |
| void | mapMesh (const polyMeshMap &) |
| Update from another mesh using the given map. More... | |
| void | distribute (const polyDistributionMap &) |
| Redistribute or update using the given distribution map. More... | |
| bool | read (const dictionary &dict) |
| Read coefficients dictionary. More... | |
| Public Member Functions inherited from polyCellSet | |
| polyCellSet (const polyMesh &mesh) | |
| Construct from mesh. Will select all. More... | |
| polyCellSet (const polyMesh &mesh, const dictionary &dict) | |
| Construct from mesh and dictionary. More... | |
| ~polyCellSet () | |
| Destructor. More... | |
| const selectionTypes & | selectionType () const |
| Return const access to the cell selection type. More... | |
| const word & | cellSetName () const |
| Return const access to the name of cellSet. More... | |
| labelUList | cells () const |
| Return const access to the cell set. More... | |
| label | nCells () const |
| Return the number of cells in the set. More... | |
| bool | all () const |
| Return true if the set comprises all the cells. More... | |
| label | celli (const label i) const |
| Return the cell index corresponding to the cell set index. More... | |
| void | movePoints () |
| Update for mesh motion. More... | |
| void | topoChange (const polyTopoChangeMap &) |
| Update topology using the given map. More... | |
| void | mapMesh (const polyMeshMap &) |
| Update from another mesh using the given map. More... | |
| void | distribute (const polyDistributionMap &) |
| Redistribute or update using the given distribution map. More... | |
| bool | read (const dictionary &dict) |
| Read coefficients dictionary. 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... | |
Additional Inherited Members | |
| Public Types inherited from polyCellSet | |
| enum class | selectionTypes { points , cellSet , cellZone , all } |
| Enumeration for selection mode types. 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... | |
| 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 polyCellSet | |
| static const NamedEnum< selectionTypes, 4 > | selectionTypeNames |
| Word list of selection type names. More... | |
| Static Public Attributes inherited from writeFile | |
| static const word | outputPrefix |
| Directory prefix. More... | |
| static label | addChars = 8 |
| Additional characters for writing. 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 fvCellSet | |
| void | writeFileHeader (const functionObjects::writeFile &wf, Ostream &file) |
| Output file header information. 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 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... | |
Writes the domain averaged reaction rates for each specie for each reaction into the file <timeDir>/specieReactionRates.dat.
Definition at line 59 of file specieReactionRates.H.
| specieReactionRates | ( | const word & | name, |
| const Time & | runTime, | ||
| const dictionary & | dict | ||
| ) |
Construct from Time and dictionary.
Definition at line 74 of file specieReactionRates.C.
References dict, and specieReactionRates::read().
|
delete |
Disallow default bitwise copy construction.
|
virtual |
Destructor.
Definition at line 98 of file specieReactionRates.C.
| TypeName | ( | "specieReactionRates" | ) |
Runtime type information.
|
virtual |
Read the specieReactionRates data.
Reimplemented from regionFunctionObject.
Definition at line 104 of file specieReactionRates.C.
References dict, and regionFunctionObject::read().
Referenced by specieReactionRates::specieReactionRates().
|
inlinevirtual |
Return the list of fields required.
Implements functionObject.
Definition at line 107 of file specieReactionRates.H.
References List< word >::null().
|
virtual |
|
virtual |
Write the specie reaction rates.
Reimplemented from logFiles.
Definition at line 120 of file specieReactionRates.C.
References cells, Foam::fvc::domainIntegrate(), Foam::endl(), Foam::file, Foam::gSum(), UPstream::master(), fvMeshFunctionObject::mesh_, Foam::nl, nSpecie, Foam::constant::physicoChemical::RR, token::TAB, and logFiles::write().
|
delete |
Disallow default bitwise assignment.
1.9.1 
