File size: 12,512 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 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 | /*---------------------------------------------------------------------------*\
========= |
\\ / 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::fvModel
Description
Finite volume model abstract base class.
SourceFiles
fvModel.C
\*---------------------------------------------------------------------------*/
#ifndef fvModel_H
#define fvModel_H
#include "fvMatricesFwd.H"
#include "volFieldsFwd.H"
#include "dictionary.H"
#include "dimensionSet.H"
#include "HashSet.H"
#include "fvModelM.H"
#include "geometricOneField.H"
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
namespace Foam
{
class fvMesh;
class polyTopoChangeMap;
class polyMeshMap;
class polyDistributionMap;
/*---------------------------------------------------------------------------*\
Class fvModel Declaration
\*---------------------------------------------------------------------------*/
class fvModel
{
// Private Data
//- Model name
const word name_;
//- Model type
const word modelType_;
//- Reference to the mesh database
const fvMesh& mesh_;
protected:
// Protected Member Functions
//- Add a source term to an equation
template<class Type>
void addSupType
(
const VolField<Type>& field,
fvMatrix<Type>& eqn
) const;
//- Add a source term to a compressible equation
template<class Type>
void addSupType
(
const volScalarField& rho,
const VolField<Type>& field,
fvMatrix<Type>& eqn
) const;
//- Add a source term to a phase equation
template<class Type>
void addSupType
(
const volScalarField& alpha,
const volScalarField& rho,
const VolField<Type>& field,
fvMatrix<Type>& eqn
) 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;
public:
//- Runtime type information
TypeName("fvModel");
//- The keywords read by this class
static const wordHashSet keywords;
// Declare run-time constructor selection table
declareRunTimeSelectionTable
(
autoPtr,
fvModel,
dictionary,
(
const word& name,
const word& modelType,
const fvMesh& mesh,
const dictionary& dict
),
(name, modelType, mesh, dict)
);
// Static Member Functions
//- Return the coefficients sub-dictionary for a given model type
inline static const dictionary& coeffs
(
const word& modelType,
const dictionary&
);
//- Return the dimensions of the matrix of a source term
template<class AlphaRhoFieldType, class ... AlphaRhoFieldTypes>
static dimensionSet sourceDims
(
const dimensionSet& ds,
const AlphaRhoFieldType& alphaRhoField,
const AlphaRhoFieldTypes& ... alphaRhoFields
);
//- Return the dimensions of the matrix of a source term (base
// condition for the above)
inline static const dimensionSet& sourceDims(const dimensionSet& ds);
//- Return the name of the field associated with a source term
template<class AlphaRhoFieldType, class ... AlphaRhoFieldTypes>
static const word& fieldName
(
const AlphaRhoFieldType& alphaRhoField,
const AlphaRhoFieldTypes& ... alphaRhoFields
);
//- Return the name of the field associated with a source term (base
// condition for the above)
template<class AlphaRhoFieldType>
static const word& fieldName(const AlphaRhoFieldType& alphaRhoField);
//- Return the name of the field associated with a source term. Special
// overload for volume sources with no associated field.
static const word& fieldName();
// Constructors
//- Construct from components
fvModel
(
const word& name,
const word& modelType,
const fvMesh& mesh,
const dictionary& dict
);
//- Return clone
autoPtr<fvModel> clone() const
{
NotImplemented;
return autoPtr<fvModel>(nullptr);
}
//- Return pointer to new fvModel object created
// on the freestore from an Istream
class iNew
{
//- Reference to the mesh
const fvMesh& mesh_;
const word& name_;
public:
iNew
(
const fvMesh& mesh,
const word& name
)
:
mesh_(mesh),
name_(name)
{}
autoPtr<fvModel> operator()(Istream& is) const
{
// const word name(is);
const dictionary dict(is);
return autoPtr<fvModel>
(
fvModel::New(name_, mesh_, dict)
);
}
};
// Selectors
//- Return a reference to the selected fvModel
static autoPtr<fvModel> New
(
const word& name,
const fvMesh& mesh,
const dictionary& dict
);
//- Destructor
virtual ~fvModel();
// Member Functions
// Access
//- Return const access to the source name
inline const word& name() const;
//- Return name as the keyword
inline const word& keyword() const;
//- Return const access to the mesh database
inline const fvMesh& mesh() const;
//- Return the coefficients sub-dictionary
inline const dictionary& coeffs(const dictionary&) const;
// Checks
//- Return the list of fields for which the fvModel adds source term
// to the transport equation
virtual wordList addSupFields() const;
//- Return true if the 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
//- Add a source term to a field-less proxy equation
virtual void addSup(fvMatrix<scalar>& eqn) const;
//- Add a source term to an equation
FOR_ALL_FIELD_TYPES(DEFINE_FV_MODEL_ADD_FIELD_SUP)
//- Add a source term to a compressible equation
FOR_ALL_FIELD_TYPES(DEFINE_FV_MODEL_ADD_RHO_FIELD_SUP)
//- Add a source term to a phase equation
FOR_ALL_FIELD_TYPES(DEFINE_FV_MODEL_ADD_ALPHA_RHO_FIELD_SUP)
//- 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() = 0;
//- Update topology using the given map
virtual void topoChange(const polyTopoChangeMap&) = 0;
//- Update from another mesh using the given map
virtual void mapMesh(const polyMeshMap&) = 0;
//- Redistribute or update using the given distribution map
virtual void distribute(const polyDistributionMap&) = 0;
//- Correct the fvModel
// e.g. solve equations, update model, for film, Lagrangian etc.
virtual void correct();
// IO
//- Read source dictionary
virtual bool read(const dictionary& dict);
//- Write fvModel data
virtual bool write(const bool write = true) const;
};
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
} // End namespace Foam
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
#include "fvModelI.H"
#ifdef NoRepository
#include "fvModelTemplates.C"
#endif
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
#endif
// ************************************************************************* //
|