File size: 4,183 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 | /*---------------------------------------------------------------------------*\
========= |
\\ / F ield | OpenFOAM: The Open Source CFD Toolbox
\\ / O peration | Website: https://openfoam.org
\\ / A nd | Copyright (C) 2023-2025 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::adjustTimeStepToChemistry
Description
Returns the minimum chemistry chemical time scale
This allows the solver to temporally resolve chemical changes, in order to
better couple the chemistry and transport, or in order to accurately
post-process the chemical changes.
Note that this function only does anything if time step adjustment is
enabled in the controlDict.
Example of function object specification:
\verbatim
adjustTimeStepToChemistry
{
type adjustTimeStepToChemistry;
libs ("libchemistryModel.so");
}
\endverbatim
Usage
\table
Property | Description | Required | Default value
type | type name: adjustTimeStepToChemistry | yes |
phase | name of the reacting phase | no |
\endtable
SourceFiles
adjustTimeStepToChemistry.C
\*---------------------------------------------------------------------------*/
#ifndef adjustTimeStepToChemistry_functionObject_H
#define adjustTimeStepToChemistry_functionObject_H
#include "regionFunctionObject.H"
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
namespace Foam
{
namespace functionObjects
{
/*---------------------------------------------------------------------------*\
Class adjustTimeStepToChemistry Declaration
\*---------------------------------------------------------------------------*/
class adjustTimeStepToChemistry
:
public regionFunctionObject
{
// Private Data
//- Name of the phase
word phaseName_;
public:
//- Runtime type information
TypeName("adjustTimeStepToChemistry");
// Constructors
//- Construct from components
adjustTimeStepToChemistry
(
const word& name,
const Time& runTime,
const dictionary& dict
);
//- Disallow default bitwise copy construction
adjustTimeStepToChemistry(const adjustTimeStepToChemistry&) = delete;
// Destructor
virtual ~adjustTimeStepToChemistry();
// 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 chemistry.deltaTChem()
virtual scalar maxDeltaT() const;
// Member Operators
//- Disallow default bitwise assignment
void operator=(const adjustTimeStepToChemistry&) = delete;
};
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
} // End namespace functionObjects
} // End namespace Foam
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
#endif
// ************************************************************************* //
|