These functions calculate the specie-flux and write it as a surfaceScalarField called 'specie<Type>Flux(<specieName>)'. There are three such functions; specieAdvectiveFlux and specieDiffusiveFlux return the advective and diffusive parts of the flux, respectively, and specieFlux returns the total combined flux. More...
Public Member Functions | |
| TypeName ("specieFlux") | |
| Runtime type information. More... | |
| specieFlux (const word &name, const Time &runTime, const dictionary &dict) | |
| Construct from Time and dictionary. More... | |
 Public Member Functions inherited from specieFluxBase | |
| specieFluxBase (const word &name, const Time &runTime, const dictionary &dict, const word &typeName) | |
| Construct from Time and dictionary. More... | |
| virtual | ~specieFluxBase () |
| Destructor. More... | |
| Public Member Functions inherited from fieldExpression | |
| TypeName ("fieldExpression") | |
| Runtime type information. More... | |
| fieldExpression (const word &name, const Time &runTime, const dictionary &dict, const word &functionName, const word &defaultFieldName=word::null) | |
| Construct from Time and dictionary. More... | |
| fieldExpression (const fieldExpression &)=delete | |
| Disallow default bitwise copy construction. More... | |
| virtual | ~fieldExpression () |
| Destructor. More... | |
| virtual wordList | fields () const |
| Return the field required. More... | |
| virtual bool | execute () |
| Calculate the result field. More... | |
| virtual bool | write () |
| Write the result field. More... | |
| virtual bool | clear () |
| Clear the result field from the objectRegistry. More... | |
| void | operator= (const fieldExpression &)=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... | |
| virtual bool | read (const dictionary &) |
| Read optional controls. 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 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... | |
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 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 specieFluxBase | |
| tmp< surfaceScalarField > | calcPhiYif (const fluidThermophysicalTransportModel &ttm, const volScalarField &Yi) const |
| Return the advective flux. More... | |
| tmp< surfaceScalarField > | calcJ (const fluidThermophysicalTransportModel &ttm, const volScalarField &Yi) const |
| Return the diffusive flux. More... | |
| Protected Member Functions inherited from fvMeshFunctionObject | |
| labelHashSet | patchSet (const dictionary &, const bool optional=false) const |
| Return the patch set corresponding to the patch selection entries. 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... | |
| 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 > | |
| 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 fieldExpression | |
| const word | fieldName_ |
| Name of field to process. More... | |
| word | resultName_ |
| Name of result field. 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... | |
These functions calculate the specie-flux and write it as a surfaceScalarField called 'specie<Type>Flux(<specieName>)'. There are three such functions; specieAdvectiveFlux and specieDiffusiveFlux return the advective and diffusive parts of the flux, respectively, and specieFlux returns the total combined flux.
Example of function object specification:
specieFlux
{
type specieFlux; // specieAdvectiveFlux, specieDiffusiveFlux
libs ("libfieldFunctionObjects.so");
field NH3;
}
Or, using the standard configuration:
#includeFunc specieFlux(NH3)
| Property | Description | Required | Default value |
|---|---|---|---|
type | Type name: specieFlux, specieAdvectiveFlux, or specieDiffusiveFlux | yes | |
field | Name of the specie/mass fraction field | yes | |
schemesField | Name of the field from which schemes are taken | no | Yi |
region | Region to be evaluated | no | default region |
Definition at line 173 of file specieFlux.H.
| specieFlux | ( | const word & | name, |
| const Time & | runTime, | ||
| const dictionary & | dict | ||
| ) |
Construct from Time and dictionary.
Definition at line 170 of file specieFlux.C.
| TypeName | ( | "specieFlux" | ) |
Runtime type information.
1.9.1