File size: 9,168 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 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 | /*---------------------------------------------------------------------------*\
========= |
\\ / F ield | OpenFOAM: The Open Source CFD Toolbox
\\ / O peration | Website: https://openfoam.org
\\ / A nd | Copyright (C) 2021-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::fvModels
Description
Finite volume models
SourceFiles
fvModels.C
\*---------------------------------------------------------------------------*/
#ifndef fvModels_H
#define fvModels_H
#include "fvModel.H"
#include "PtrListDictionary.H"
#include "DemandDrivenMeshObject.H"
#include "IOdictionary.H"
#include "HashSet.H"
#include "geometricOneField.H"
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
namespace Foam
{
// Forward declaration of friend functions and operators
class fvModels;
Ostream& operator<<(Ostream& os, const fvModels& models);
/*---------------------------------------------------------------------------*\
Class fvModels Declaration
\*---------------------------------------------------------------------------*/
class fvModels
:
public DemandDrivenMeshObject
<
fvMesh,
TopoChangeableMeshObject,
fvModels,
IOdictionary
>,
public PtrListDictionary<fvModel>
{
// Private Data
//- Time index to check that all defined sources have been applied
mutable label checkTimeIndex_;
//- Sets of the fields that have had sources added by the fvModels
mutable PtrList<wordHashSet> addSupFields_;
// Private Member Functions
//- Create IO object if dictionary is present
static IOobject createIOobject(const fvMesh& mesh);
//- Check that all fvModels have been applied
void checkApplied() const;
//- Return a source for an equation
template<class Type, class ... AlphaRhoFieldTypes>
tmp<fvMatrix<Type>> sourceTerm
(
const VolField<Type>& eqnField,
const dimensionSet& ds,
const AlphaRhoFieldTypes& ... alphaRhoFields
) const;
protected:
friend class DemandDrivenMeshObject;
// Protected Constructors
//- Construct from fvMesh
explicit fvModels(const fvMesh& mesh);
public:
//- Runtime type information
TypeName("fvModels");
// Constructors
//- Disallow default bitwise copy construction
fvModels(const fvModels&) = delete;
//- Inherit the base New method
using DemandDrivenMeshObject
<
fvMesh,
TopoChangeableMeshObject,
fvModels,
IOdictionary
>::New;
//- Destructor
virtual ~fvModels()
{}
// Member Functions
// Checks
//- Return true if an fvModel adds a source term to the given
// field's transport equation
virtual bool addsSupToField(const word& fieldName) const;
//- Return the maximum time-step for stable operation
virtual scalar maxDeltaT() const;
// Sources
//- Correct the fvModels
// e.g. solve equations, update model, for film, Lagrangian etc.
virtual void correct();
//- Return source for an equation
template<class Type>
tmp<fvMatrix<Type>> sourceProxy
(
const VolField<Type>& eqnField
) const;
//- Return source for an equation
template<class Type>
tmp<fvMatrix<Type>> source
(
const VolField<Type>& field
) const;
//- Return source for an equation
template<class Type>
tmp<fvMatrix<Type>> sourceProxy
(
const VolField<Type>& field,
const VolField<Type>& eqnField
) const;
//- Return source for a compressible equation
template<class Type>
tmp<fvMatrix<Type>> source
(
const volScalarField& rho,
const VolField<Type>& field
) const;
//- Return source for a compressible equation
template<class Type>
tmp<fvMatrix<Type>> sourceProxy
(
const volScalarField& rho,
const VolField<Type>& field,
const VolField<Type>& eqnField
) const;
//- Return source for a phase equation
template<class Type>
tmp<fvMatrix<Type>> source
(
const volScalarField& alpha,
const volScalarField& rho,
const VolField<Type>& field
) const;
//- Return source for a phase equation
template<class Type>
tmp<fvMatrix<Type>> sourceProxy
(
const volScalarField& alpha,
const volScalarField& rho,
const VolField<Type>& field,
const VolField<Type>& eqnField
) const;
//- Return source for a phase equation
template<class Type>
tmp<fvMatrix<Type>> source
(
const volScalarField& alpha,
const geometricOneField& rho,
const VolField<Type>& field
) const;
//- Return source for a phase equation
template<class Type>
tmp<fvMatrix<Type>> source
(
const geometricOneField& alpha,
const volScalarField& rho,
const VolField<Type>& field
) const;
//- Return source for a phase equation
template<class Type>
tmp<fvMatrix<Type>> source
(
const geometricOneField& alpha,
const geometricOneField& rho,
const VolField<Type>& field
) const;
//- Return source for an equation with a second time derivative
template<class Type>
tmp<fvMatrix<Type>> d2dt2
(
const VolField<Type>& field
) const;
// Mesh changes
//- Prepare for mesh update
virtual void preUpdateMesh();
//- Update for mesh motion
virtual bool movePoints();
//- 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&);
// IO
//- Read the fvModels dictionary if it has changed
// and update the models
virtual bool read();
//- Write the fvModels
virtual bool writeObject
(
IOstream::streamFormat fmt,
IOstream::versionNumber ver,
IOstream::compressionType cmp,
const bool write
) const;
// Member Operators
//- Inherit the PtrListDictionary index operators
using PtrListDictionary<fvModel>::operator[];
//- Inherit the PtrListDictionary size function
using PtrListDictionary<fvModel>::size;
//- Disallow default bitwise assignment
void operator=(const fvModels&) = delete;
// IOstream Operators
//- Ostream operator
friend Ostream& operator<<
(
Ostream& os,
const fvModels& models
);
};
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
//- Trait for obtaining global status
template<>
struct typeGlobal<fvModels>
{
static const bool global = true;
};
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
#ifdef NoRepository
#include "fvModelsTemplates.C"
#endif
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
} // End namespace Foam
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
#endif
// ************************************************************************* //
|