File size: 4,684 Bytes
5a600cf | 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 | /*---------------------------------------------------------------------------*\
========= |
\\ / F ield | OpenFOAM: The Open Source CFD Toolbox
\\ / O peration | Website: https://openfoam.org
\\ / A nd | Copyright (C) 2024-2026 OpenFOAM Foundation
\\/ M anipulation |
-------------------------------------------------------------------------------
License
This file is part of OpenFOAM.
OpenFOAM is free software: you can redistribute it and/or modify it
under the terms of the GNU General Public License as published by
the Free Software Foundation, either version 3 of the License, or
(at your option) any later version.
OpenFOAM is distributed in the hope that it will be useful, but WITHOUT
ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
for more details.
You should have received a copy of the GNU General Public License
along with OpenFOAM. If not, see <http://www.gnu.org/licenses/>.
Class
Foam::functionObjects::reactionRates
Description
Writes volume averaged reaction rates in [kmol/m^3/s] for
each reaction into the file \<timeDir\>/reactionRates.dat
Example of function object specification:
\verbatim
reactionRates1
{
type reactionRates;
libs ("libchemistryModel.so");
cellZone all; // Or points, cellSet, cellZone
//phase <phaseName>; // Optional name of the phase
//writeFields false; // Optionally also write the rate fields. Note
// that this can create a lot of data.
}
\endverbatim
See also
Foam::functionObjects::fvMeshFunctionObject
Foam::fvCellZone
Foam::functionObjects::logFiles
SourceFiles
reactionRates.C
\*---------------------------------------------------------------------------*/
#ifndef reactionRates_functionObject_H
#define reactionRates_functionObject_H
#include "fvMeshFunctionObject.H"
#include "fvCellZone.H"
#include "logFiles.H"
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
namespace Foam
{
namespace functionObjects
{
/*---------------------------------------------------------------------------*\
Class reactionRates Declaration
\*---------------------------------------------------------------------------*/
class reactionRates
:
public fvMeshFunctionObject,
public logFiles
{
// Private Data
//- cellZone
fvCellZone zone_;
//- Name of the phase
const word phaseName_;
//- Whether or not to write the reaction rate fields
bool writeFields_;
// Private Member Functions
//- File header information
virtual void writeFileHeader(const label i);
public:
//- Runtime type information
TypeName("reactionRates");
// Constructors
//- Construct from Time and dictionary
reactionRates
(
const word& name,
const Time& runTime,
const dictionary& dict
);
//- Disallow default bitwise copy construction
reactionRates(const reactionRates&) = delete;
//- Destructor
virtual ~reactionRates();
// Member Functions
//- Read the reactionRates data
virtual bool read(const dictionary&);
//- Return the list of fields required
virtual wordList fields() const
{
return wordList::null();
}
//- Do nothing
virtual bool execute();
//- Write the reaction rates
virtual bool write();
// Mesh changes
//- Update for mesh motion
virtual void movePoints(const polyMesh&);
//- Update topology using the given map
virtual void topoChange(const polyTopoChangeMap&);
//- Update from another mesh using the given map
virtual void mapMesh(const polyMeshMap&);
//- Redistribute or update using the given distribution map
virtual void distribute(const polyDistributionMap&);
// Member Operators
//- Disallow default bitwise assignment
void operator=(const reactionRates&) = delete;
};
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
} // End namespace functionObjects
} // End namespace Foam
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
#endif
// ************************************************************************* //
|