File size: 7,894 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 | /*---------------------------------------------------------------------------*\
========= |
\\ / F ield | OpenFOAM: The Open Source CFD Toolbox
\\ / O peration | Website: https://openfoam.org
\\ / A nd | Copyright (C) 2019-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::functionObjects::phaseScalarTransport
Description
Evolves a passive scalar transport equation within one phase of a
multiphase simulation. The scalar is considered to be a phase-intensive
property; i.e., its value represents an amount per-unit of the phase. In
addition to the scalar, the function also writes out the product of the
volume fraction and the scalar, as this provides a phase-extensive field
which is often more convenient to post-process.
Most entries are the same as for the \c scalarTransport function. Refer to
its documentation for details. Entries specific to this function are
detailed below. Note that the phase-name will be determined by stripping
the extension from the supplied field name.
If the solver does not provide an \c alphaPhi flux, or that flux is for
some reason unreliable, then the \c solveAlphaPhi switch can be used to
make this function solve a pressure-like equation from which \c alphaPhi is
recovered.
Usage
\table
Property | Description | Req'd? | Default
alpha | Name of the volume-fraction field | no\\
| alpha.<phase-name>
alphaPhi | Name of the phase-flux field | no\\
| alphaPhi.<phase-name>
solveAlphaPhi | Solve for the alphaPhi flux, rather than looking it\\
up | no | false
p | Name of the pressure field | no | p
residualAlpha | Small volume fraction used to stabilise the solution\\
| no | rootSmall
writeAlphaField | Also write out alpha multiplied by the field\\
| no | true
\endtable
Example specification for incompressibleVoF:
\verbatim
phaseScalarTransport1
{
type phaseScalarTransport;
libs ("libsolverFunctionObjects.so");
field s.water;
}
\endverbatim
Example specification for multiphaseEuler:
\verbatim
phaseScalarTransport1
{
type phaseScalarTransport;
libs ("libsolverFunctionObjects.so");
field s.water;
alphaPhi alphaRhoPhi.water;
rho rho.water;
}
\endverbatim
See also
Foam::functionObjects::fvMeshFunctionObject
Foam::functionObjects::scalarTransport
SourceFiles
phaseScalarTransport.C
\*---------------------------------------------------------------------------*/
#ifndef phaseScalarTransport_functionObject_H
#define phaseScalarTransport_functionObject_H
#include "scalarTransport.H"
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
namespace Foam
{
namespace functionObjects
{
/*---------------------------------------------------------------------------*\
Class phaseScalarTransport Declaration
\*---------------------------------------------------------------------------*/
class phaseScalarTransport
:
public fvMeshFunctionObject
{
// Private Data
//- Name of field to process
const word fieldName_;
//- Name of the phase in which to solve
const word phaseName_;
//- Solve for the alphaPhi flux, rather than looking it up (optional)
bool solveAlphaPhi_;
//- Name of phase volume-fraction field (optional)
word alphaName_;
//- Name of the phase flux field (optional)
word alphaPhiName_;
//- Name of the mixture flux field (optional)
word phiName_;
//- Name of density field (optional)
word rhoName_;
//- Name of the pressure field (optional)
word pName_;
//- The type of diffusivity
scalarTransport::diffusivityType diffusivity_;
//- Constant diffusivity coefficient (optional)
dimensionedScalar D_;
//- Diffusivity field name (optional)
word Dname_;
//- Laminar diffusivity coefficient (optional)
dimensionedScalar alphal_;
//- Turbulent diffusivity coefficient (optional)
dimensionedScalar alphat_;
//- Residual volume-fraction
scalar residualAlpha_;
//- Name of field whose schemes are used (optional)
word schemesField_;
//- Name of field whose solver is used (optional)
word solverField_;
//- Flag to indicate whether to write the field multiplied by the phase
// fraction
bool writeAlphaField_;
//- The field
volScalarField s_;
//- The field multiplied by the phase fraction
autoPtr<volScalarField> alphaSPtr_;
//- Potential field used to generate the phase flux
autoPtr<volScalarField> PhiPtr_;
// Private Member Functions
//- Return the potential field used to generate the phase flux.
// Constructed on demand.
volScalarField& Phi();
//- Return the phase flux. Tries to look it up, and generates it if the
// lookup fails. The generation creates a crude guess for alphaPhi
// then solves a Laplacian to correct the flux to match the time
// derivative of alpha.
tmp<surfaceScalarField> alphaPhi();
//- Return the diffusivity field
tmp<volScalarField> D(const surfaceScalarField& alphaPhi) const;
public:
//- Runtime type information
TypeName("phaseScalarTransport");
// Constructors
//- Construct from Time and dictionary
phaseScalarTransport
(
const word& name,
const Time& runTime,
const dictionary& dict
);
//- Destructor
virtual ~phaseScalarTransport();
// Member Functions
//- Read the settings from the given dictionary
virtual bool read(const dictionary&);
//- Return the list of fields required
virtual wordList fields() const;
//- Do not execute at the start of the run
virtual bool executeAtStart() const
{
return false;
}
//- Solve for the evolution of the field
virtual bool execute();
//- Do nothing. The field is registered and written automatically.
virtual bool write();
};
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
} // End namespace functionObjects
} // End namespace Foam
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
#endif
// ************************************************************************* //
|