function1.C
Go to the documentation of this file.
1 /*---------------------------------------------------------------------------*\
2  ========= |
3  \\ / F ield | OpenFOAM: The Open Source CFD Toolbox
4  \\ / O peration |
5  \\ / A nd | www.openfoam.com
6  \\/ M anipulation |
7 -------------------------------------------------------------------------------
8  Copyright (C) 2017-2018 OpenFOAM Foundation
9 -------------------------------------------------------------------------------
10 License
11  This file is part of OpenFOAM.
12 
13  OpenFOAM is free software: you can redistribute it and/or modify it
14  under the terms of the GNU General Public License as published by
15  the Free Software Foundation, either version 3 of the License, or
16  (at your option) any later version.
17 
18  OpenFOAM is distributed in the hope that it will be useful, but WITHOUT
19  ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
20  FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
21  for more details.
22 
23  You should have received a copy of the GNU General Public License
24  along with OpenFOAM. If not, see <http://www.gnu.org/licenses/>.
25 
26 \*---------------------------------------------------------------------------*/
27 
28 #include "function1.H"
30 
31 // * * * * * * * * * * * * * * Static Data Members * * * * * * * * * * * * * //
32 
33 namespace Foam
34 {
35 namespace saturationModels
36 {
37  defineTypeNameAndDebug(function1, 0);
38  addToRunTimeSelectionTable(saturationModel, function1, dictionary);
39 }
40 }
41 
42 
43 // * * * * * * * * * * * * * * * * Constructors * * * * * * * * * * * * * * //
44 
46 (
47  const dictionary& dict,
48  const objectRegistry& db
49 )
50 :
51  saturationModel(db),
52  function_
53  (
54  Function1<scalar>::New("function", dict, &db)
55  )
56 {}
57 
58 
59 // * * * * * * * * * * * * * * * * Destructor * * * * * * * * * * * * * * * //
60 
62 {}
63 
64 
65 // * * * * * * * * * * * * * * * Member Functions * * * * * * * * * * * * * //
66 
69 (
70  const volScalarField& T
71 ) const
72 {
74  return volScalarField::null();
75 }
76 
77 
80 (
81  const volScalarField& T
82 ) const
83 {
85  return volScalarField::null();
86 }
87 
88 
91 (
92  const volScalarField& T
93 ) const
94 {
96  return volScalarField::null();
97 }
98 
99 
102 (
103  const volScalarField& p
104 ) const
105 {
106  tmp<volScalarField> tTsat
107  (
109  (
110  "Tsat",
111  p.mesh(),
113  )
114  );
115 
116  volScalarField& Tsat = tTsat.ref();
117 
118  forAll(Tsat, celli)
119  {
120  Tsat[celli] = function_->value(p[celli]);
121  }
122 
123  volScalarField::Boundary& TsatBf = Tsat.boundaryFieldRef();
124 
125  forAll(Tsat.boundaryField(), patchi)
126  {
127  scalarField& Tsatp = TsatBf[patchi];
128  const scalarField& pp = p.boundaryField()[patchi];
129 
130  forAll(Tsatp, facei)
131  {
132  Tsatp[facei] = function_->value(pp[facei]);
133 
134  }
135  }
136 
137  return tTsat;
138 }
139 
140 
141 // ************************************************************************* //
p
volScalarField & p
Definition: createFieldRefs.H:8
Foam::saturationModels::function1::~function1
virtual ~function1()
Destructor.
Definition: function1.C:61
Foam::tmp
A class for managing temporary objects.
Definition: PtrList.H:61
Foam::saturationModels::function1::function1
function1(const dictionary &dict, const objectRegistry &db)
Construct from a dictionary.
Definition: function1.C:46
Foam::saturationModel
Definition: saturationModel.H:53
Foam::saturationModels::function1::pSat
virtual tmp< volScalarField > pSat(const volScalarField &T) const
Saturation pressure.
Definition: function1.C:69
Foam::saturationModels::function1::pSatPrime
virtual tmp< volScalarField > pSatPrime(const volScalarField &T) const
Saturation pressure derivetive w.r.t. temperature.
Definition: function1.C:80
Foam::saturationModels::addToRunTimeSelectionTable
addToRunTimeSelectionTable(saturationModel, Antoine, dictionary)
Foam::Function1
Top level data entry class for use in dictionaries. Provides a mechanism to specify a variable as a c...
Definition: propellerInfo.H:291
forAll
#define forAll(list, i)
Loop across all elements in list.
Definition: stdFoam.H:296
Foam::GeometricField< scalar, fvPatchField, volMesh >::New
static tmp< GeometricField< scalar, fvPatchField, volMesh > > New(const word &name, const Mesh &mesh, const dimensionSet &ds, const word &patchFieldType=fvPatchField< scalar >::calculatedType())
Return tmp field from name, mesh, dimensions and patch type.
Definition: GeometricFieldNew.C:34
Foam::objectRegistry
Registry of regIOobjects.
Definition: objectRegistry.H:60
NotImplemented
#define NotImplemented
Issue a FatalErrorIn for a function not currently implemented.
Definition: error.H:517
Foam::tmp::ref
T & ref() const
Definition: tmpI.H:227
Foam::Field< scalar >
Foam::T
void T(FieldField< Field, Type > &f1, const FieldField< Field, Type > &f2)
Definition: FieldFieldFunctions.C:58
Foam::dimensionedScalar
dimensioned< scalar > dimensionedScalar
Dimensioned scalar obtained from generic dimensioned type.
Definition: dimensionedScalarFwd.H:42
dict
dictionary dict
Definition: searchingEngine.H:14
Foam::dictionary
A list of keyword definitions, which are a keyword followed by a number of values (eg,...
Definition: dictionary.H:123
addToRunTimeSelectionTable.H
Macros for easy insertion into run-time selection tables.
function1.H
Foam
Namespace for OpenFOAM.
Definition: atmBoundaryLayer.C:33
Foam::saturationModels::function1::Tsat
virtual tmp< volScalarField > Tsat(const volScalarField &p) const
Saturation temperature.
Definition: function1.C:102
Foam::saturationModels::defineTypeNameAndDebug
defineTypeNameAndDebug(Antoine, 0)
Foam::GeometricField::boundaryFieldRef
Boundary & boundaryFieldRef(const bool updateAccessTime=true)
Return a reference to the boundary field.
Definition: GeometricField.C:783
Foam::dimTemperature
const dimensionSet dimTemperature(0, 0, 0, 1, 0, 0, 0)
Definition: dimensionSets.H:54
Foam::GeometricField< scalar, fvPatchField, volMesh >::null
static const GeometricField< scalar, fvPatchField, volMesh > & null()
Return a null geometric field.
Definition: GeometricFieldI.H:32
Foam::GeometricField< scalar, fvPatchField, volMesh >
Foam::saturationModels::function1::lnPSat
virtual tmp< volScalarField > lnPSat(const volScalarField &T) const
Natural log of the saturation pressure.
Definition: function1.C:91
Foam::GeometricField::boundaryField
const Boundary & boundaryField() const
Return const-reference to the boundary field.
Definition: GeometricFieldI.H:62