mirror of
https://develop.openfoam.com/Development/openfoam.git
synced 2025-11-28 03:28:01 +00:00
3eec5854be
In most boundary conditions, fvOptions etc. required and optional fields
to be looked-up from the objectRegistry are selected by setting the
keyword corresponding to the standard field name in the BC etc. to the
appropriate name in the objectRegistry. Usually a default is provided
with sets the field name to the keyword name, e.g. in the
totalPressureFvPatchScalarField the velocity is selected by setting the
keyword 'U' to the appropriate name which defaults to 'U':
Property | Description | Required | Default value
U | velocity field name | no | U
phi | flux field name | no | phi
.
.
.
However, in some BCs and functionObjects and many fvOptions another
convention is used in which the field name keyword is appended by 'Name'
e.g.
Property | Description | Required | Default value
pName | pressure field name | no | p
UName | velocity field name | no | U
This difference in convention is unnecessary and confusing, hinders code
and dictionary reuse and complicates code maintenance. In this commit
the appended 'Name' is removed from the field selection keywords
standardizing OpenFOAM on the first convention above.
160 lines
4.0 KiB
C++
160 lines
4.0 KiB
C++
/*---------------------------------------------------------------------------*\
|
|
========= |
|
|
\\ / F ield | OpenFOAM: The Open Source CFD Toolbox
|
|
\\ / O peration |
|
|
\\ / A nd | Copyright (C) 2012-2016 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::fixedTemperatureConstraint
|
|
|
|
Description
|
|
Fixed temperature equation constraint
|
|
|
|
Sources described by:
|
|
|
|
fixedTemperatureConstraintCoeffs
|
|
{
|
|
mode uniform; // uniform or lookup
|
|
|
|
// For uniform option
|
|
temperature constant 500; // fixed temperature with time [K]
|
|
|
|
// For lookup option
|
|
// T <Tname>; // optional temperature field name
|
|
}
|
|
|
|
Note:
|
|
The 'uniform' option allows the use of a time-varying uniform temperature
|
|
by means of the Function1 type.
|
|
|
|
SourceFiles
|
|
fvOption.C
|
|
|
|
\*---------------------------------------------------------------------------*/
|
|
|
|
#ifndef fixedTemperatureConstraint_H
|
|
#define fixedTemperatureConstraint_H
|
|
|
|
#include "cellSetOption.H"
|
|
#include "NamedEnum.H"
|
|
#include "Function1.H"
|
|
|
|
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
|
|
|
|
namespace Foam
|
|
{
|
|
namespace fv
|
|
{
|
|
|
|
/*---------------------------------------------------------------------------*\
|
|
Class fixedTemperatureConstraint Declaration
|
|
\*---------------------------------------------------------------------------*/
|
|
|
|
class fixedTemperatureConstraint
|
|
:
|
|
public cellSetOption
|
|
{
|
|
|
|
public:
|
|
|
|
//- Temperature mode
|
|
enum temperatureMode
|
|
{
|
|
tmUniform,
|
|
tmLookup
|
|
};
|
|
|
|
|
|
//- String representation of temperatureMode enums
|
|
static const NamedEnum<temperatureMode, 2> temperatureModeNames_;
|
|
|
|
|
|
protected:
|
|
|
|
// Protected data
|
|
|
|
//- Operation mode
|
|
temperatureMode mode_;
|
|
|
|
//- Uniform temperature [K]
|
|
autoPtr<Function1<scalar>> Tuniform_;
|
|
|
|
//- Temperature field name
|
|
word TName_;
|
|
|
|
|
|
private:
|
|
|
|
// Private Member Functions
|
|
|
|
//- Disallow default bitwise copy construct
|
|
fixedTemperatureConstraint(const fixedTemperatureConstraint&);
|
|
|
|
//- Disallow default bitwise assignment
|
|
void operator=(const fixedTemperatureConstraint&);
|
|
|
|
|
|
public:
|
|
|
|
//- Runtime type information
|
|
TypeName("fixedTemperatureConstraint");
|
|
|
|
|
|
// Constructors
|
|
|
|
//- Construct from components
|
|
fixedTemperatureConstraint
|
|
(
|
|
const word& name,
|
|
const word& modelType,
|
|
const dictionary& dict,
|
|
const fvMesh& mesh
|
|
);
|
|
|
|
|
|
//- Destructor
|
|
virtual ~fixedTemperatureConstraint()
|
|
{}
|
|
|
|
|
|
// Member Functions
|
|
|
|
//- Constrain energy equation to fix the temperature
|
|
virtual void constrain(fvMatrix<scalar>& eqn, const label fieldi);
|
|
|
|
|
|
// IO
|
|
|
|
//- Read dictionary
|
|
virtual bool read(const dictionary& dict);
|
|
};
|
|
|
|
|
|
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
|
|
|
|
} // End namespace fv
|
|
} // End namespace Foam
|
|
|
|
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
|
|
|
|
#endif
|
|
|
|
// ************************************************************************* //
|