File size: 4,064 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 | /*---------------------------------------------------------------------------*\
========= |
\\ / F ield | OpenFOAM: The Open Source CFD Toolbox
\\ / O peration | Website: https://openfoam.org
\\ / A nd | Copyright (C) 2022-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::fluidMaxDeltaT
Description
Returns the maximum time-step evaluated from time-dependent
maximum Courant number and maximum time-step specifications.
The \c maxCo and \c maxDeltaT are provided as \c Function1 of time,
supporting constant, tabulated and functional specifications.
Usage
Example of a time-dependent maximum Courant number:
\verbatim
fluidMaxDeltaT
{
type fluidMaxDeltaT;
maxCo table
(
(0 0.2)
(0.6 0.2)
(0.7 0.1)
);
maxDeltaT 1;
}
\endverbatim
See also
Foam::functionObject
Foam::functionObjects::fvMeshFunctionObject
Foam::Function1
SourceFiles
fluidMaxDeltaT.C
\*---------------------------------------------------------------------------*/
#ifndef fluidMaxDeltaT_H
#define fluidMaxDeltaT_H
#include "fvMeshFunctionObject.H"
#include "Function1.H"
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
namespace Foam
{
namespace functionObjects
{
/*---------------------------------------------------------------------------*\
Class fluidMaxDeltaT Declaration
\*---------------------------------------------------------------------------*/
class fluidMaxDeltaT
:
public fvMeshFunctionObject
{
// Private Data
//- Max Courant number function/table
autoPtr<Function1<scalar>> maxCoPtr_;
//- Max time-step function/table
autoPtr<Function1<scalar>> maxDeltaTPtr_;
public:
//- Runtime type information
TypeName("fluidMaxDeltaT");
// Constructors
//- Construct from Time and dictionary
fluidMaxDeltaT
(
const word& name,
const Time& runTime,
const dictionary& dict
);
//- Disallow default bitwise copy construction
fluidMaxDeltaT(const fluidMaxDeltaT&) = delete;
//- Destructor
virtual ~fluidMaxDeltaT();
// Member Functions
//- Read the controls
virtual bool read(const dictionary&);
//- Return the list of fields required
virtual wordList fields() const
{
return wordList::null();
}
//- Execute, currently does nothing
virtual bool execute();
//- Write the time step value
virtual bool write();
//- Return the maximum time-step for stable operation
virtual scalar maxDeltaT() const;
// Member Operators
//- Disallow default bitwise assignment
void operator=(const fluidMaxDeltaT&) = delete;
};
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
} // End namespace functionObjects
} // End namespace Foam
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
#endif
// ************************************************************************* //
|