All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Pages
inletOutletFvPatchField.C
Go to the documentation of this file.
1 /*---------------------------------------------------------------------------*\
2  ========= |
3  \\ / F ield | OpenFOAM: The Open Source CFD Toolbox
4  \\ / O peration | Website: https://openfoam.org
5  \\ / A nd | Copyright (C) 2011-2019 OpenFOAM Foundation
6  \\/ M anipulation |
7 -------------------------------------------------------------------------------
8 License
9  This file is part of OpenFOAM.
10 
11  OpenFOAM is free software: you can redistribute it and/or modify it
12  under the terms of the GNU General Public License as published by
13  the Free Software Foundation, either version 3 of the License, or
14  (at your option) any later version.
15 
16  OpenFOAM is distributed in the hope that it will be useful, but WITHOUT
17  ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
18  FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
19  for more details.
20 
21  You should have received a copy of the GNU General Public License
22  along with OpenFOAM. If not, see <http://www.gnu.org/licenses/>.
23 
24 \*---------------------------------------------------------------------------*/
25 
27 
28 // * * * * * * * * * * * * * * * * Constructors * * * * * * * * * * * * * * //
29 
30 template<class Type>
32 (
33  const fvPatch& p,
35 )
36 :
38  phiName_("phi")
39 {
40  this->refValue() = Zero;
41  this->refGrad() = Zero;
42  this->valueFraction() = 0.0;
43 }
44 
45 
46 template<class Type>
48 (
50  const fvPatch& p,
52  const fvPatchFieldMapper& mapper
53 )
54 :
55  mixedFvPatchField<Type>(ptf, p, iF, mapper),
56  phiName_(ptf.phiName_)
57 {}
58 
59 
60 template<class Type>
62 (
63  const fvPatch& p,
65  const dictionary& dict
66 )
67 :
69  phiName_(dict.lookupOrDefault<word>("phi", "phi"))
70 {
71  this->refValue() = Field<Type>("inletValue", dict, p.size());
72 
73  if (dict.found("value"))
74  {
76  (
77  Field<Type>("value", dict, p.size())
78  );
79  }
80  else
81  {
82  fvPatchField<Type>::operator=(this->refValue());
83  }
84 
85  this->refGrad() = Zero;
86  this->valueFraction() = 0.0;
87 }
88 
89 
90 template<class Type>
92 (
94 )
95 :
97  phiName_(ptf.phiName_)
98 {}
99 
100 
101 template<class Type>
103 (
106 )
107 :
108  mixedFvPatchField<Type>(ptf, iF),
109  phiName_(ptf.phiName_)
110 {}
111 
112 
113 // * * * * * * * * * * * * * * * Member Functions * * * * * * * * * * * * * //
114 
115 template<class Type>
117 {
118  if (this->updated())
119  {
120  return;
121  }
122 
123  const Field<scalar>& phip =
124  this->patch().template lookupPatchField<surfaceScalarField, scalar>
125  (
126  phiName_
127  );
128 
129  this->valueFraction() = 1.0 - pos0(phip);
130 
132 }
133 
134 
135 template<class Type>
137 {
139  if (phiName_ != "phi")
140  {
141  writeEntry(os, "phi", phiName_);
142  }
143  writeEntry(os, "inletValue", this->refValue());
144  writeEntry(os, "value", *this);
145 }
146 
147 
148 // * * * * * * * * * * * * * * * Member Operators * * * * * * * * * * * * * //
149 
150 template<class Type>
151 void Foam::inletOutletFvPatchField<Type>::operator=
152 (
153  const fvPatchField<Type>& ptf
154 )
155 {
157  (
158  this->valueFraction()*this->refValue()
159  + (1 - this->valueFraction())*ptf
160  );
161 }
162 
163 
164 // ************************************************************************* //
dictionary dict
virtual void write(Ostream &) const
Write.
A list of keyword definitions, which are a keyword followed by any number of values (e...
Definition: dictionary.H:158
void size(const label)
Override size to be inconsistent with allocated storage.
Definition: ListI.H:164
A finiteVolume patch using a polyPatch and a fvBoundaryMesh.
Definition: fvPatch.H:61
This boundary condition provides a base class for &#39;mixed&#39; type boundary conditions, i.e. conditions that mix fixed value and patch-normal gradient conditions.
Abstract base class with a fat-interface to all derived classes covering all possible ways in which t...
Definition: fvPatchField.H:66
Pre-declare SubField and related Field type.
Definition: Field.H:56
A class for handling words, derived from string.
Definition: word.H:59
virtual void updateCoeffs()
Update the coefficients associated with the patch field.
Foam::fvPatchFieldMapper.
void write(std::ostream &os, const bool binary, List< floatScalar > &fField)
Write floats ascii or binary.
static const zero Zero
Definition: zero.H:97
An Ostream is an abstract base class for all output systems (streams, files, token lists...
Definition: Ostream.H:54
dimensionedScalar pos0(const dimensionedScalar &ds)
void writeEntry(Ostream &os, const HashTable< T, Key, Hash > &ht)
Definition: HashTableIO.C:96
T lookupOrDefault(const word &, const T &, bool recursive=false, bool patternMatch=true) const
Find and return a T,.
Field with dimensions and associated with geometry type GeoMesh which is used to size the field and a...
volScalarField & p
inletOutletFvPatchField(const fvPatch &, const DimensionedField< Type, volMesh > &)
Construct from patch and internal field.
This boundary condition provides a generic outflow condition, with specified inflow for the case of r...