OpenFOAM-dev / data /src /fvModels /general /massSource /massSourceBase.H
introvoyz042's picture
Migrated from GitHub
5a600cf verified
Raw History Blame Contribute Delete
4.56 kB
/*---------------------------------------------------------------------------*\
========= |
\\ / 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::fv::massSourceBase
Description
Base class for mass source models
SourceFiles
massSourceBase.C
\*---------------------------------------------------------------------------*/
#ifndef massSourceBase_H
#define massSourceBase_H
#include "fvTotalSource.H"
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
namespace Foam
{
namespace fv
{
/*---------------------------------------------------------------------------*\
Class massSourceBase Declaration
\*---------------------------------------------------------------------------*/
class massSourceBase
:
public fvTotalSource
{
// Private Data
//- Name of the density field
word rhoName_;
// Private Member Functions
//- Non-virtual read
void readCoeffs(const dictionary& dict);
// Sources
//- 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 scalar equation
void addSupType
(
const volScalarField& rhoOrField,
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 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;
public:
//- Runtime type information
TypeName("massSourceBase");
// Constructors
//- Construct from explicit source name and mesh
massSourceBase
(
const word& name,
const word& modelType,
const fvMesh& mesh,
const dictionary& dict
);
// Member Functions
// 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);
//- Read source dictionary
virtual bool read(const dictionary& dict);
};
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
} // End namespace fv
} // End namespace Foam
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
#endif
// ************************************************************************* //