07f5080f2e
A number of fvOptions that apply to a user-derined field can now
automatically work what primitive type they apply to. These options can
apply to any field type, and in some cases even multiple fields of
differing type. Example usage of the options to which this change
applies are shown below:
codedSource1
{
type codedSource;
name codedSource1;
field h;
...
}
fixedValueConstraint1
{
type fixedValueConstraint;
fieldValues
{
R (1 0 0 1 0 1);
epsilon 150;
}
...
}
phaseLimitStabilization11
{
type phaseLimitStabilization;
field sigma.liquid;
...
}
Previously to apply to a given type, these options had to be selected
with the name of the type prepended to the option name (e.g., "type
symmTensorPhaseLimitStabilization;") and those that operated on multiple
fields were restricted to those fields being of the same type.
A number of other options have had improvements made to their handling
of user specification of fields. Where possible, the option will now
attempt to work out what field the option applies to automatically. The
following options, therefore, no longer require "field" or "fields"
entries:
actuationDiskSource
buoyancyEnergy
buoyancyForce
meanVelocityForce
rotorDiskSource
volumeFractionSource
constantHeatTransfer
function2HeatTransfer
variableHeatTransfer
Non-standard field names can be overridden in the same way as in
boundary conditions; e.g., the velocity name can be overridden with a "U
<UName>;" entry if it does not have the default name, "U". The name of
the energy field is now always determined from the thermodynamics
model and should always be correct. Some options that can be applied to
an individual phase also support a "phase <phaseName>;" entry;
fvOptions field-name handling has been rewritten to increase its
flexibility and to improve warning messages. The flexibility now allows
for options that apply to all fields, or all fields of a given phase,
rather than being limited to a specific list of field names. Messages
warning about options that have not been applied now always print just
once per time-step.
187 lines
4.4 KiB
C++
187 lines
4.4 KiB
C++
/*---------------------------------------------------------------------------*\
|
|
========= |
|
|
\\ / F ield | OpenFOAM: The Open Source CFD Toolbox
|
|
\\ / O peration | Website: https://openfoam.org
|
|
\\ / A nd | Copyright (C) YEAR 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/>.
|
|
|
|
\*---------------------------------------------------------------------------*/
|
|
|
|
#include "codedFvOptionTemplate.H"
|
|
#include "addToRunTimeSelectionTable.H"
|
|
#include "fvPatchFieldMapper.H"
|
|
#include "volFields.H"
|
|
#include "surfaceFields.H"
|
|
#include "unitConversion.H"
|
|
#include "fvMatrix.H"
|
|
|
|
//{{{ begin codeInclude
|
|
${codeInclude}
|
|
//}}} end codeInclude
|
|
|
|
|
|
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
|
|
|
|
namespace Foam
|
|
{
|
|
|
|
namespace fv
|
|
{
|
|
|
|
// * * * * * * * * * * * * * * * Local Functions * * * * * * * * * * * * * * //
|
|
|
|
//{{{ begin localCode
|
|
${localCode}
|
|
//}}} end localCode
|
|
|
|
|
|
// * * * * * * * * * * * * * * * Global Functions * * * * * * * * * * * * * //
|
|
|
|
extern "C"
|
|
{
|
|
// dynamicCode:
|
|
// SHA1 = ${SHA1sum}
|
|
//
|
|
// unique function name that can be checked if the correct library version
|
|
// has been loaded
|
|
void ${typeName}_${SHA1sum}(bool load)
|
|
{
|
|
if (load)
|
|
{
|
|
// code that can be explicitly executed after loading
|
|
}
|
|
else
|
|
{
|
|
// code that can be explicitly executed before unloading
|
|
}
|
|
}
|
|
}
|
|
|
|
// * * * * * * * * * * * * * * Static Data Members * * * * * * * * * * * * * //
|
|
|
|
defineTypeNameAndDebug(${typeName}FvOption${SourceType}, 0);
|
|
|
|
addRemovableToRunTimeSelectionTable
|
|
(
|
|
option,
|
|
${typeName}FvOption${SourceType},
|
|
dictionary
|
|
);
|
|
|
|
|
|
const char* const ${typeName}FvOption${SourceType}::SHA1sum =
|
|
"${SHA1sum}";
|
|
|
|
|
|
// * * * * * * * * * * * * * * * * Constructors * * * * * * * * * * * * * * //
|
|
|
|
${typeName}FvOption${SourceType}::
|
|
${typeName}FvOption${SourceType}
|
|
(
|
|
const word& name,
|
|
const word& modelType,
|
|
const dictionary& dict,
|
|
const fvMesh& mesh
|
|
)
|
|
:
|
|
cellSetOption(name, modelType, dict, mesh)
|
|
{
|
|
if (${verbose:-false})
|
|
{
|
|
Info<<"construct ${typeName} sha1: ${SHA1sum}"
|
|
" from components\n";
|
|
}
|
|
}
|
|
|
|
|
|
// * * * * * * * * * * * * * * * * Destructor * * * * * * * * * * * * * * * //
|
|
|
|
${typeName}FvOption${SourceType}::
|
|
~${typeName}FvOption${SourceType}()
|
|
{
|
|
if (${verbose:-false})
|
|
{
|
|
Info<<"destroy ${typeName} sha1: ${SHA1sum}\n";
|
|
}
|
|
}
|
|
|
|
|
|
// * * * * * * * * * * * * * * * Member Functions * * * * * * * * * * * * * //
|
|
|
|
void ${typeName}FvOption${SourceType}::addSup
|
|
(
|
|
fvMatrix<${TemplateType}>& eqn,
|
|
const word& fieldName
|
|
) const
|
|
{
|
|
if (${verbose:-false})
|
|
{
|
|
Info<<"${typeName}FvOption${SourceType}::addSup()\n";
|
|
}
|
|
|
|
//{{{ begin code
|
|
${codeAddSup}
|
|
//}}} end code
|
|
}
|
|
|
|
|
|
void ${typeName}FvOption${SourceType}::addSup
|
|
(
|
|
const volScalarField& rho,
|
|
fvMatrix<${TemplateType}>& eqn,
|
|
const word& fieldName
|
|
) const
|
|
{
|
|
if (${verbose:-false})
|
|
{
|
|
Info<<"${typeName}FvOption${SourceType}::addSup()\n";
|
|
}
|
|
|
|
//{{{ begin code
|
|
${codeAddRhoSup}
|
|
//}}} end code
|
|
}
|
|
|
|
|
|
void ${typeName}FvOption${SourceType}::addSup
|
|
(
|
|
const volScalarField& alpha,
|
|
const volScalarField& rho,
|
|
fvMatrix<${TemplateType}>& eqn,
|
|
const word& fieldName
|
|
) const
|
|
{
|
|
if (${verbose:-false})
|
|
{
|
|
Info<<"${typeName}FvOption${SourceType}::addSup()\n";
|
|
}
|
|
|
|
//{{{ begin code
|
|
${codeAddAlphaRhoSup}
|
|
//}}} end code
|
|
}
|
|
|
|
|
|
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
|
|
|
|
} // End namespace Foam
|
|
} // End namespace fv
|
|
|
|
// ************************************************************************* //
|