File size: 4,753 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 | /*---------------------------------------------------------------------------*\
========= |
\\ / F ield | OpenFOAM: The Open Source CFD Toolbox
\\ / O peration | Website: https://openfoam.org
\\ / A nd | Copyright (C) 2021-2025 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::fvTotalSource
Description
Base class for sources which are specified as a total value (e.g., volume
or mass flow rate), rather than a specific value (e.g., mass flow rate per
unit volume).
SourceFiles
fvTotalSource.C
\*---------------------------------------------------------------------------*/
#ifndef fvTotalSource_H
#define fvTotalSource_H
#include "fvSource.H"
#include "cellZone.H"
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
namespace Foam
{
/*---------------------------------------------------------------------------*\
Class fvTotalSource Declaration
\*---------------------------------------------------------------------------*/
class fvTotalSource
:
public fvSource
{
private:
// Private Data
//- Name of the phase
word phaseName_;
// Private Member Functions
//- Non-virtual read
void readCoeffs(const dictionary& dict);
protected:
// Protected Member Functions
// Sources
//- Add a source term to a field-less proxy equation
void addSource(fvMatrix<scalar>& eqn) 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 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;
public:
//- Runtime type information
TypeName("fvTotalSource");
// Constructors
//- Construct from explicit source name and mesh
fvTotalSource
(
const word& name,
const word& modelType,
const fvMesh& mesh,
const dictionary& dict
);
//- Destructor
virtual ~fvTotalSource();
// 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;
// Access
//- Return the phase name
inline const word& phaseName() const;
//- Return the cellZone that the source applies to
virtual const cellZone& zone() const = 0;
//- Return the volume of cells that the source applies to
virtual scalar V() const = 0;
// Sources
//- Return the source value
virtual dimensionedScalar S() const = 0;
// IO
//- Read source dictionary
virtual bool read(const dictionary& dict);
};
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
} // End namespace Foam
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
#include "fvTotalSourceI.H"
#ifdef NoRepository
#include "fvTotalSourceTemplates.C"
#endif
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
#endif
// ************************************************************************* //
|