fixedMeanFvPatchField.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) 2012-2016 OpenFOAM Foundation
9  Copyright (C) 2017-2021 OpenCFD Ltd.
10 -------------------------------------------------------------------------------
11 License
12  This file is part of OpenFOAM.
13 
14  OpenFOAM is free software: you can redistribute it and/or modify it
15  under the terms of the GNU General Public License as published by
16  the Free Software Foundation, either version 3 of the License, or
17  (at your option) any later version.
18 
19  OpenFOAM is distributed in the hope that it will be useful, but WITHOUT
20  ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
21  FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
22  for more details.
23 
24  You should have received a copy of the GNU General Public License
25  along with OpenFOAM. If not, see <http://www.gnu.org/licenses/>.
26 
27 \*---------------------------------------------------------------------------*/
28 
29 #include "fixedMeanFvPatchField.H"
30 #include "volFields.H"
31 
32 // * * * * * * * * * * * * * * * * Constructors * * * * * * * * * * * * * * //
33 
34 template<class Type>
36 (
37  const fvPatch& p,
39 )
40 :
42  meanValue_()
43 {}
44 
45 
46 template<class Type>
48 (
49  const fvPatch& p,
51  const dictionary& dict
52 )
53 :
55  meanValue_(Function1<Type>::New("meanValue", dict, &this->db()))
56 {
57  this->patchType() = dict.getOrDefault<word>("patchType", word::null);
58 }
59 
60 
61 template<class Type>
63 (
64  const fixedMeanFvPatchField<Type>& ptf,
65  const fvPatch& p,
67  const fvPatchFieldMapper& mapper
68 )
69 :
70  fixedValueFvPatchField<Type>(ptf, p, iF, mapper),
71  meanValue_(ptf.meanValue_.clone())
72 {}
73 
74 
75 template<class Type>
77 (
79 )
80 :
82  meanValue_(ptf.meanValue_.clone())
83 {}
84 
85 
86 template<class Type>
88 (
89  const fixedMeanFvPatchField<Type>& ptf,
91 )
92 :
94  meanValue_(ptf.meanValue_.clone())
95 {}
96 
97 
98 // * * * * * * * * * * * * * * * Member Functions * * * * * * * * * * * * * //
99 
100 template<class Type>
102 {
103  if (this->updated())
104  {
105  return;
106  }
107 
108  const scalar t = this->db().time().timeOutputValue();
109  Type meanValue = meanValue_->value(t);
110 
111  Field<Type> newValues(this->patchInternalField());
112 
113  Type meanValuePsi =
114  gSum(this->patch().magSf()*newValues)
115  /gSum(this->patch().magSf());
116 
117  if (mag(meanValue) > SMALL && mag(meanValuePsi) > 0.5*mag(meanValue))
118  {
119  newValues *= mag(meanValue)/mag(meanValuePsi);
120  }
121  else
122  {
123  newValues += (meanValue - meanValuePsi);
124  }
125 
126  this->operator==(newValues);
127 
129 }
130 
131 
132 template<class Type>
134 {
136  meanValue_->writeData(os);
137  this->writeEntry("value", os);
138 }
139 
140 
141 // ************************************************************************* //
volFields.H
p
volScalarField & p
Definition: createFieldRefs.H:8
Foam::word
A class for handling words, derived from Foam::string.
Definition: word.H:65
Foam::fixedMeanFvPatchField::fixedMeanFvPatchField
fixedMeanFvPatchField(const fvPatch &, const DimensionedField< Type, volMesh > &)
Construct from patch and internal field.
Definition: fixedMeanFvPatchField.C:36
Foam::gSum
Type gSum(const FieldField< Field, Type > &f)
Definition: FieldFieldFunctions.C:594
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
Foam::fixedValueFvPatchField
This boundary condition supplies a fixed value constraint, and is the base class for a number of othe...
Definition: fixedValueFvPatchField.H:80
Foam::Field
Generic templated field type.
Definition: Field.H:63
Foam::operator==
tmp< faMatrix< Type > > operator==(const faMatrix< Type > &, const faMatrix< Type > &)
Foam::fvPatch
A finiteVolume patch using a polyPatch and a fvBoundaryMesh.
Definition: fvPatch.H:65
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
os
OBJstream os(runTime.globalPath()/outputName)
Foam::fixedMeanFvPatchField::write
virtual void write(Ostream &) const
Write.
Definition: fixedMeanFvPatchField.C:133
Foam::fixedMeanFvPatchField::updateCoeffs
virtual void updateCoeffs()
Update the coefficients associated with the patch field.
Definition: fixedMeanFvPatchField.C:101
Foam::foamVersion::patch
const std::string patch
OpenFOAM patch number as a std::string.
Foam::mag
dimensioned< typename typeOfMag< Type >::type > mag(const dimensioned< Type > &dt)
Foam::vtk::write
void write(vtk::formatter &fmt, const Type &val, const label n=1)
Component-wise write of a value (N times)
Definition: foamVtkOutputTemplates.C:36
Foam::fvPatchFieldMapper
Foam::fvPatchFieldMapper.
Definition: fvPatchFieldMapper.H:47
Foam::Ostream
An Ostream is an abstract base class for all output systems (streams, files, token lists,...
Definition: Ostream.H:56
Foam::fixedMeanFvPatchField
This boundary condition extrapolates field to the patch using the near-cell values and adjusts the di...
Definition: fixedMeanFvPatchField.H:86
Foam::DimensionedField
Field with dimensions and associated with geometry type GeoMesh which is used to size the field and a...
Definition: DimensionedField.H:54
fixedMeanFvPatchField.H