File size: 9,005 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 | /*---------------------------------------------------------------------------*\
========= |
\\ / F ield | OpenFOAM: The Open Source CFD Toolbox
\\ / O peration | Website: https://openfoam.org
\\ / A nd | Copyright (C) 2025-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::fv::cloud
Description
Finite volume model that solves for the evolution of a cloud. Provides
two-way coupling with a finite-volume carrier phase.
SourceFiles
cloud_fvModel.C
cloud_fvModelTemplates.C
\*---------------------------------------------------------------------------*/
#ifndef cloud_fvModel_H
#define cloud_fvModel_H
#include "fvSource.H"
#include "coupled.H"
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
namespace Foam
{
namespace fv
{
/*---------------------------------------------------------------------------*\
Class cloud Declaration
\*---------------------------------------------------------------------------*/
class cloud
:
public fvSource
{
// Private Data
//- The cloud
autoPtr<Foam::cloud> cloudPtr_;
//- Cloud reference (for convenience)
const Foam::cloud& cloud_;
//- Carried cloud reference (for convenience)
const clouds::carried& carriedCloud_;
//- Coupled cloud reference (for convenience)
const clouds::coupled& coupledCloud_;
// Private Member Functions
//- Fail with a message indicating that a source could not be added
template<class Type>
void fail(const fvMatrix<Type>& eqn) const;
//- Fail with a message indicating that a source could not be added
template<class Type, class ... AlphaRhoFieldTypes>
void fail
(
const fvMatrix<Type>& eqn,
const AlphaRhoFieldTypes& ... alphaRhoFields
) const;
// Sources
//- Return the material source for the given phase
tmp<volInternalScalarField> S
(
const word& phaseName,
const dimensionSet& dims
) const;
//- Return the material source for the given phase
template<class Type>
tmp<fvMatrix<Type>> Sfield
(
const VolField<Type>& field,
const dimensionSet& dims
) const;
//- 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 phase continuity equation or a scalar
// equation
void addSupType
(
const volScalarField& alphaOrField,
fvMatrix<scalar>& 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 compressible phase continuity equation
// or a compressible scalar equation
void addSupType
(
const volScalarField& alphaOrRho,
const volScalarField& rhoOrField,
fvMatrix<scalar>& 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;
protected:
// Protected Classes
//- Empty template class used to template the constructor on the type
// of the cloud
template<class Type>
class Cloud
{};
// Protected Constructors
//- Construct from components
template<class Type>
cloud
(
const word& name,
const word& modelType,
const fvMesh& mesh,
const dictionary& dict,
const Cloud<Type>&
);
public:
// Public Static Data
//- Run-time type information
TypeName("cloud");
//- Destructor
virtual ~cloud();
// Member Functions
// Checks
//- Return true if the fvModel adds a source term to the given
// field's transport equation
virtual bool addsSupToField(const word& fieldName) 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)
//- Solve the evolution of the cloud over the current time-step
virtual void correct();
// 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&);
};
/*---------------------------------------------------------------------------*\
Class Cloud Declaration
\*---------------------------------------------------------------------------*/
template<class Type>
class Cloud
:
public cloud
{
public:
// Public Static Data
//- Run-time type information
TypeName("Cloud");
// Constructors
//- Construct from components
Cloud
(
const word& name,
const word& modelType,
const fvMesh& mesh,
const dictionary& dict
);
};
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
} // End namespace fv
} // End namespace Foam
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
#ifdef NoRepository
#include "cloud_fvModelTemplates.C"
#endif
#define makeCloudFvModel(Type) \
\
typedef Cloud<clouds::Type> Type##CloudFvModel; \
\
defineTemplateTypeNameAndDebugWithName \
( \
Type##CloudFvModel, \
(clouds::Type::typeName + "Cloud").c_str(), \
0 \
); \
\
addToRunTimeSelectionTable \
( \
fvModel, \
Type##CloudFvModel, \
dictionary \
);
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
#endif
// ************************************************************************* //
|