File size: 4,286 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 | /*---------------------------------------------------------------------------*\
========= |
\\ / 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::fvSource
Description
Base class for finite volume sources
SourceFiles
fvSource.C
\*---------------------------------------------------------------------------*/
#ifndef fvSource_H
#define fvSource_H
#include "fvModel.H"
#include "scalarField.H"
#include "DimensionedFieldFwd.H"
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
namespace Foam
{
/*---------------------------------------------------------------------------*\
Class fvSource Declaration
\*---------------------------------------------------------------------------*/
class fvSource
:
public fvModel
{
public:
//- Runtime type information
TypeName("fvSource");
// Static Member Functions
//- Print min/average/max information for a given field
static void infoField
(
const word& name,
const dimensionSet& dims,
const scalarField& field,
const bool print = true
);
//- Print min/average/max information for a given field
static void infoField
(
const word& name,
const DimensionedField<scalar, fvMesh>& field,
const bool print = true
);
//- Print min/average/max information for a given field
static void infoField
(
const DimensionedField<scalar, fvMesh>& field,
const bool print = true
);
// Constructors
//- Construct from explicit source name and mesh
fvSource
(
const word& name,
const word& modelType,
const fvMesh& mesh,
const dictionary& dict
);
//- Disallow default bitwise copy construction
fvSource(const fvSource&) = delete;
//- Destructor
virtual ~fvSource();
// Member Functions
// Checks
//- Return true if the fvModel adds a source term to the given
// field's transport equation. Must be provided by sources.
// Sources potentially apply to every field (or every field of a
// phase) and it is not known in advance what all the fields are.
// So, this function returns a logical test (e.g., is this the
// phase of which there is a source?) rather than testing whether
// the name is in a pre-determined set of names.
virtual bool addsSupToField(const word& fieldName) const = 0;
//- Return the list of fields for which the fvModel adds source term
// to the transport equation. Sources return null, as all this
// logic is handled in addsSupToField.
virtual wordList addSupFields() const final;
// Member Operators
//- Disallow default bitwise assignment
void operator=(const fvSource&) = delete;
};
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
} // End namespace Foam
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
#endif
// ************************************************************************* //
|