File size: 5,132 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 173 174 | /*---------------------------------------------------------------------------*\
========= |
\\ / F ield | OpenFOAM: The Open Source CFD Toolbox
\\ / O peration | Website: https://openfoam.org
\\ / A nd | Copyright (C) 2023-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::adjustTimeStepToReaction
Description
Returns the minimum bulk reaction time scale
This allows the solver to temporally resolve chemical changes, in order to
better couple the chemistry and transport, or to improve the time-accuracy
of post-processing.
Note that this function only does anything if time step adjustment is
enabled in the controlDict.
Example of function object specification:
\verbatim
adjustTimeStepToReaction
{
type adjustTimeStepToReaction;
libs ("libreactionModels.so");
maxCo 0.1;
extrapolate no;
}
\endverbatim
Usage
\table
Property | Description | Required | Default value
type | type name: adjustTimeStepToReaction | yes |
phase | name of the reacting phase | no |
maxCo | maximum reaction "Courant" number | no | 1
extrapolate | try to extrapolate decreases | no | false
\endtable
SourceFiles
adjustTimeStepToReaction.C
\*---------------------------------------------------------------------------*/
#ifndef adjustTimeStepToReaction_functionObject_H
#define adjustTimeStepToReaction_functionObject_H
#include "regionFunctionObject.H"
#include "timeIOdictionary.H"
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
namespace Foam
{
namespace functionObjects
{
/*---------------------------------------------------------------------------*\
Class adjustTimeStepToReaction Declaration
\*---------------------------------------------------------------------------*/
class adjustTimeStepToReaction
:
public regionFunctionObject
{
// Private Data
//- Name of the phase
word phaseName_;
//- Maximum reaction "Courant" number. The maximum fraction of the
// total reaction time-scale that should be evolved in a single
// time-step.
scalar maxCo_;
//- Extrapolate reductions in time-step to try and better catch the
// "onset" of reaction. Can lead to time-step oscillation.
bool extrapolate_;
//- Do we have the previous reaction time-step?
mutable bool haveReactionDeltaT0_;
//- The previous reaction time-step
mutable scalar reactionDeltaT0_;
// Private Member Functions
//- Get the properties dictionary IO object
typeIOobject<timeIOdictionary> propsDictIo
(
const IOobject::readOption& r
) const;
public:
//- Runtime type information
TypeName("adjustTimeStepToReaction");
// Constructors
//- Construct from components
adjustTimeStepToReaction
(
const word& name,
const Time& runTime,
const dictionary& dict
);
//- Disallow default bitwise copy construction
adjustTimeStepToReaction(const adjustTimeStepToReaction&) = delete;
// Destructor
virtual ~adjustTimeStepToReaction();
// Member Functions
//- Read and reset the timeStep Function1
virtual bool read(const dictionary&);
//- Return the list of fields required
virtual wordList fields() const
{
return wordList::null();
}
//- Do nothing
virtual bool execute();
//- Do nothing
virtual bool write();
//- Return the minimum reaction time-scale
virtual scalar maxDeltaT() const;
// Member Operators
//- Disallow default bitwise assignment
void operator=(const adjustTimeStepToReaction&) = delete;
};
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
} // End namespace functionObjects
} // End namespace Foam
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
#endif
// ************************************************************************* //
|