Files
OpenFOAM-12/src/fvModels/derived/zeroDimensionalMassSource/zeroDimensionalMassSource.H
Will Bainbridge 171101d1e5 fvModels: Specify source property values in field files
When an fvModel source introduces fluid into a simulation it should also
create a corresponding source term for all properties transported into
the domain by that injection. The source is, effectively, an alternative
form of inlet boundary, on which all transported properties need an
inlet value specified.

These values are now specified in the property field files. The
following is an example of a 0/U file in which the velocity of fluid
introduced by a fvModel source called "injection1" is set to a fixed
value of (-1 0 0):

    dimensions      [0 1 -1 0 0 0 0];

    internalField   uniform (0 0 0);

    boundaryField
    {
        #includeEtc "caseDicts/setConstraintTypes"

        wall
        {
            type            noSlip;
        }

        atmosphere
        {
            type            pressureInletOutletVelocity;
            value           $internalField;
        }
    }

    // *** NEW ***
    sources
    {
        injection1
        {
            type            uniformFixedValue;
            uniformValue    (-1 0 0);
        }
    }

And the following entry in the 0/k file specifies the turbulent kinetic
energy introduced as a fraction of the mean flow kinetic energy:

    sources
    {
        injection1
        {
            type            turbulentIntensityKineticEnergy;
            intensity       0.05;
        }
    }

The specification is directly analogous to boundary conditions. The
conditions are run-time selectable and can be concisely implemented.
They can access each other and be inter-dependent (e.g., the above,
where turbulent kinetic energy depends on velocity). The syntax keeps
field data localised and makes the source model (e.g., massSource,
volumeSource, ...) specification independent from what other models and
fields are present in the simulation. The 'fieldValues' entry previously
required by source models is now no longer required.

If source values need specifying and no source condition has been
supplied in the relevant field file then an error will be generated.
This error is similar to that generated for missing boundary conditions.
This replaces the behaviour where sources such as these would introduce
a value of zero, either silently or with a warning. This is now
considered unacceptable. Zero might be a tolerable default for certain
fields (U, k), but is wholly inappropriate for others (T, epsilon, rho).

This change additionally makes it possible to inject fluid into a
multicomponent solver with a specified temperature. Previously, it was
not possible to do this as there was no means of evaluating the energy
of fluid with the injected composition.
2023-10-12 11:24:27 +01:00

134 lines
4.0 KiB
C++

/*---------------------------------------------------------------------------*\
========= |
\\ / F ield | OpenFOAM: The Open Source CFD Toolbox
\\ / O peration | Website: https://openfoam.org
\\ / A nd | Copyright (C) 2021-2023 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::zeroDimensionalMassSource
Description
This fvModel applies a mass source to the continuity equation and to all
field equations, in a zero-dimensional case. Correction is made to account
for the mass that exits the domain due to expansion in space, so that the
model correctly applies a total mass flow rate.
This model requires a corresponding field source to be specified for all
solved-for fields.
This model will write out additional fields, zeroDimensionalMassSource:m
and zeroDimensionalMassSource:factor. The zeroDimensionalMassSource:m field
is the total accumulated mass; the sum of the starting mass, plus all mass
added by models of this type. This may differ from the actual current mass
(= rho*V) within the zero-dimensional cell if pressure or density
constraints are being used. The zeroDimensionalMassSource:factor field is
the ratio between the current mass or volume and the total accumulated mass
or volume.
Usage
Example usage:
\verbatim
zeroDimensionalMassSource
{
type zeroDimensionalMassSource;
massFlowRate 1e-4;
}
\endverbatim
SourceFiles
zeroDimensionalMassSource.C
\*---------------------------------------------------------------------------*/
#ifndef zeroDimensionalMassSource_H
#define zeroDimensionalMassSource_H
#include "zeroDimensionalMassSourceBase.H"
#include "Function1.H"
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
namespace Foam
{
namespace fv
{
/*---------------------------------------------------------------------------*\
Class zeroDimensionalMassSource Declaration
\*---------------------------------------------------------------------------*/
class zeroDimensionalMassSource
:
public zeroDimensionalMassSourceBase
{
private:
// Private Data
//- Zero-dimensional mass flow rate
autoPtr<Function1<scalar>> zeroDimensionalMassFlowRate_;
// Private Member Functions
//- Non-virtual read
void readCoeffs();
//- Return the mass flow rate
virtual scalar massFlowRate() const;
public:
//- Runtime type information
TypeName("zeroDimensionalMassSource");
// Constructors
//- Construct from explicit source name and mesh
zeroDimensionalMassSource
(
const word& name,
const word& modelType,
const fvMesh& mesh,
const dictionary& dict
);
// Member Functions
//- Read source dictionary
virtual bool read(const dictionary& dict);
};
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
} // End namespace fv
} // End namespace Foam
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
#endif
// ************************************************************************* //