File size: 14,335 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 | /*---------------------------------------------------------------------------*\
========= |
\\ / F ield | OpenFOAM: The Open Source CFD Toolbox
\\ / O peration | Website: https://openfoam.org
\\ / A nd | Copyright (C) 2023-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::fvFieldSource
Description
Base class for finite-volume field sources
SourceFiles
fvFieldSource.C
\*---------------------------------------------------------------------------*/
#ifndef fvFieldSource_H
#define fvFieldSource_H
#include "DimensionedField.H"
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
namespace Foam
{
// Forward declaration of classes
class fvMesh;
class dictionary;
class fvSource;
template<class Type>
class fvFieldSource;
// Forward declaration of friend functions and operators
template<class Type>
Ostream& operator<<(Ostream&, const fvFieldSource<Type>&);
/*---------------------------------------------------------------------------*\
Class fvFieldSource Declaration
\*---------------------------------------------------------------------------*/
template<class Type>
class fvFieldSource
{
// Private Data
//- Optional list of libraries required for this field source value
fileNameList libs_;
//- Reference to internal field
const DimensionedField<Type, fvMesh>& internalField_;
public:
//- Runtime type information
TypeName("fvFieldSource");
//- Debug switch to disallow the use of genericFvFieldSource
static int disallowGenericFvFieldSource;
// Declare run-time constructor selection tables
//- Select given internal field
declareRunTimeSelectionTable
(
autoPtr,
fvFieldSource,
null,
(const DimensionedField<Type, fvMesh>& iF),
(iF)
);
//- Select given internal field and dictionary
declareRunTimeSelectionTable
(
autoPtr,
fvFieldSource,
dictionary,
(
const DimensionedField<Type, fvMesh>& iF,
const dictionary& dict
),
(iF, dict)
);
// Constructors
//- Construct from internal field
fvFieldSource(const DimensionedField<Type, fvMesh>&);
//- Construct from internal field and dictionary
fvFieldSource
(
const DimensionedField<Type, fvMesh>&,
const dictionary&
);
//- Disallow copy without setting internal field reference
fvFieldSource(const fvFieldSource<Type>&) = delete;
//- Disallow clone without setting internal field reference
autoPtr<fvFieldSource<Type>> clone() const
{
NotImplemented;
return autoPtr<fvFieldSource<Type>>(nullptr);
}
//- Copy constructor setting internal field reference
fvFieldSource
(
const fvFieldSource<Type>&,
const DimensionedField<Type, fvMesh>&
);
//- Construct and return a clone setting internal field reference
virtual autoPtr<fvFieldSource<Type>> clone
(
const DimensionedField<Type, fvMesh>&
) const = 0;
// Selectors
//- Return a pointer to a new field source
static autoPtr<fvFieldSource<Type>> New
(
const word& fieldSourceType,
const DimensionedField<Type, fvMesh>&
);
//- Return a pointer to a new field source created from a dictionary
static autoPtr<fvFieldSource<Type>> New
(
const DimensionedField<Type, fvMesh>&,
const dictionary&
);
//- Destructor
virtual ~fvFieldSource();
// Member Functions
//- Return the local object registry
const objectRegistry& db() const;
//- Return time
const Time& time() const;
//- Return the internal field reference
const DimensionedField<Type, fvMesh>& internalField() const;
//- Return the source value
virtual tmp<DimensionedField<Type, fvMesh>> sourceValue
(
const fvSource& model,
const DimensionedField<scalar, fvMesh>& source
) const = 0;
//- Return the source value
virtual tmp<Field<Type>> sourceValue
(
const fvSource& model,
const scalarField& source,
const labelUList& cells
) const;
//- Return the internal coefficient
virtual tmp<DimensionedField<scalar, fvMesh>> internalCoeff
(
const fvSource& model,
const DimensionedField<scalar, fvMesh>& source
) const = 0;
//- Return the internal coefficient
virtual tmp<scalarField> internalCoeff
(
const fvSource& model,
const scalarField& source,
const labelUList& cells
) const;
//- Return the source term. A default implementation is provided here,
// which is just one-minus the internal coefficient multiplied by the
// source and the value. Derivations may override this if needed.
virtual tmp<DimensionedField<Type, fvMesh>> sourceTerm
(
const fvSource& model,
const DimensionedField<scalar, fvMesh>& source
) const;
//- Return the source term. As above, for a subset of cells.
virtual tmp<Field<Type>> sourceTerm
(
const fvSource& model,
const scalarField& source,
const labelUList& cells
) const;
//- Return the term
tmp<DimensionedField<Type, fvMesh>> term
(
const fvSource& model,
const DimensionedField<scalar, fvMesh>& source
) const;
//- Return the term
tmp<Field<Type>> term
(
const fvSource& model,
const scalarField& source,
const labelUList& cells
) const;
//- Return the value
tmp<DimensionedField<Type, fvMesh>> value
(
const fvSource& model,
const DimensionedField<scalar, fvMesh>& source
) const;
//- Return the value
tmp<Field<Type>> value
(
const fvSource& model,
const scalarField& source,
const labelUList& cells
) const;
//- Lookup and return another field source
template<class OtherType>
const fvFieldSource<OtherType>& fieldSource
(
const word& name,
const fvSource& model
) const;
//- Lookup and return the value of another field source
template<class OtherType>
tmp<DimensionedField<OtherType, fvMesh>> value
(
const word& name,
const fvSource& model,
const DimensionedField<scalar, fvMesh>& source
) const;
//- Lookup and return the value of another field source
template<class OtherType>
tmp<Field<OtherType>> value
(
const word& name,
const fvSource& model,
const scalarField& source,
const labelUList& cells
) const;
//- Write
virtual void write(Ostream&) const;
//- Ostream operator
friend Ostream& operator<< <Type>(Ostream&, const fvFieldSource<Type>&);
};
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
} // End namespace Foam
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
#ifdef NoRepository
#include "fvFieldSource.C"
#endif
#define makeFvFieldSource(fvTypeFieldSource) \
defineNamedTemplateTypeNameAndDebug(fvTypeFieldSource, 0); \
template<> \
int fvTypeFieldSource::disallowGenericFvFieldSource \
( \
debug::debugSwitch("disallowGenericFvFieldSource", 0) \
); \
defineTemplateRunTimeSelectionTable(fvTypeFieldSource, null); \
defineTemplateRunTimeSelectionTable(fvTypeFieldSource, dictionary)
#define addToFieldSourceRunTimeSelection(TypeFieldSource, typeTypeFieldSource) \
addToRunTimeSelectionTable \
( \
TypeFieldSource, \
typeTypeFieldSource, \
dictionary \
)
#define addNullConstructableToFieldSourceRunTimeSelection( \
TypeFieldSource, typeTypeFieldSource) \
addToRunTimeSelectionTable \
( \
TypeFieldSource, \
typeTypeFieldSource, \
null \
); \
addToFieldSourceRunTimeSelection(TypeFieldSource, typeTypeFieldSource)
#define makeTypeFieldSource(TypeFieldSource, typeTypeFieldSource) \
defineTypeNameAndDebug(typeTypeFieldSource, 0); \
addToFieldSourceRunTimeSelection(TypeFieldSource, typeTypeFieldSource)
#define makeNullConstructableTypeFieldSource( \
TypeFieldSource, typeTypeFieldSource) \
defineTypeNameAndDebug(typeTypeFieldSource, 0); \
addNullConstructableToFieldSourceRunTimeSelection \
( \
TypeFieldSource, \
typeTypeFieldSource \
)
#define makeTemplateTypeFieldSource(fieldType, type) \
defineNamedTemplateTypeNameAndDebug \
( \
CAT4(type, Fv, CAPITALIZE(fieldType), FieldSource), \
0 \
); \
addToFieldSourceRunTimeSelection \
( \
CAT3(fv, CAPITALIZE(fieldType), FieldSource), \
CAT4(type, Fv, CAPITALIZE(fieldType), FieldSource) \
);
#define makeNullConstructableTemplateTypeFieldSource(fieldType, type) \
defineNamedTemplateTypeNameAndDebug \
( \
CAT4(type, Fv, CAPITALIZE(fieldType), FieldSource), \
0 \
); \
addNullConstructableToFieldSourceRunTimeSelection \
( \
CAT3(fv, CAPITALIZE(fieldType), FieldSource), \
CAT4(type, Fv, CAPITALIZE(fieldType), FieldSource) \
);
#define makeFieldSources(type) \
FOR_ALL_FIELD_TYPES(makeTemplateTypeFieldSource, type)
#define makeNullConstructableFieldSources(type) \
FOR_ALL_FIELD_TYPES(makeNullConstructableTemplateTypeFieldSource, type)
#define makeFieldSourceTypeName(fieldType, type) \
defineNamedTemplateTypeNameAndDebug \
( \
CAT4(type, Fv, CAPITALIZE(fieldType), FieldSource), \
0 \
);
#define makeFieldSourceTypeNames(type) \
FOR_ALL_FIELD_TYPES(makeFieldSourceTypeName, type)
#define makeTypeFieldSourceTypedef(fieldType, type) \
typedef type##FvFieldSource<fieldType> \
CAT4(type, Fv, CAPITALIZE(fieldType), FieldSource);
#define makeTypeFieldSourceTypedefs(type) \
FOR_ALL_FIELD_TYPES(makeTypeFieldSourceTypedef, type)
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
#endif
// ************************************************************************* //
|