uniformFixedGradientFvPatchField.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) 2013-2016 OpenFOAM Foundation
9  Copyright (C) 2017-2020 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 "uniformFixedGradientFvPatchField.H"
30 
31 // * * * * * * * * * * * * * * * * Constructors * * * * * * * * * * * * * * //
32 
33 template<class Type>
34 Foam::uniformFixedGradientFvPatchField<Type>::uniformFixedGradientFvPatchField
35 (
36  const fvPatch& p,
37  const DimensionedField<Type, volMesh>& iF
38 )
39 :
40  fixedGradientFvPatchField<Type>(p, iF),
41  uniformGradient_(nullptr)
42 {}
43 
44 
45 template<class Type>
46 Foam::uniformFixedGradientFvPatchField<Type>::uniformFixedGradientFvPatchField
47 (
48  const fvPatch& p,
49  const DimensionedField<Type, volMesh>& iF,
50  const Field<Type>& fld
51 )
52 :
53  fixedGradientFvPatchField<Type>(p, iF, fld),
54  uniformGradient_(nullptr)
55 {}
56 
57 
58 template<class Type>
59 Foam::uniformFixedGradientFvPatchField<Type>::uniformFixedGradientFvPatchField
60 (
61  const fvPatch& p,
62  const DimensionedField<Type, volMesh>& iF,
63  const dictionary& dict
64 )
65 :
66  fixedGradientFvPatchField<Type>(p, iF),
67  uniformGradient_
68  (
69  PatchFunction1<Type>::New(p.patch(), "uniformGradient", dict)
70  )
71 {
72  this->patchType() = dict.getOrDefault<word>("patchType", word::null);
73  this->evaluate();
74 }
75 
76 
77 template<class Type>
78 Foam::uniformFixedGradientFvPatchField<Type>::uniformFixedGradientFvPatchField
79 (
80  const uniformFixedGradientFvPatchField<Type>& ptf,
81  const fvPatch& p,
82  const DimensionedField<Type, volMesh>& iF,
83  const fvPatchFieldMapper& mapper
84 )
85 :
86  fixedGradientFvPatchField<Type>(ptf, p, iF, mapper),
87  uniformGradient_(ptf.uniformGradient_.clone())
88 {}
89 
90 
91 template<class Type>
92 Foam::uniformFixedGradientFvPatchField<Type>::uniformFixedGradientFvPatchField
93 (
94  const uniformFixedGradientFvPatchField<Type>& ptf
95 )
96 :
97  fixedGradientFvPatchField<Type>(ptf),
98  uniformGradient_(ptf.uniformGradient_.clone())
99 {}
100 
101 
102 template<class Type>
103 Foam::uniformFixedGradientFvPatchField<Type>::uniformFixedGradientFvPatchField
104 (
105  const uniformFixedGradientFvPatchField<Type>& ptf,
106  const DimensionedField<Type, volMesh>& iF
107 )
108 :
109  fixedGradientFvPatchField<Type>(ptf, iF),
110  uniformGradient_(ptf.uniformGradient_.clone())
111 {
112  // Evaluate the profile if defined
113  if (ptf.uniformGradient_)
114  {
115  this->evaluate();
116  }
117 }
118 
119 
120 // * * * * * * * * * * * * * * * Member Functions * * * * * * * * * * * * * //
121 
122 template<class Type>
123 void Foam::uniformFixedGradientFvPatchField<Type>::updateCoeffs()
124 {
125  if (this->updated())
126  {
127  return;
128  }
129 
130  const scalar t = this->db().time().timeOutputValue();
131  this->gradient() = uniformGradient_->value(t);
132 
133  fixedGradientFvPatchField<Type>::updateCoeffs();
134 }
135 
136 
137 template<class Type>
138 void Foam::uniformFixedGradientFvPatchField<Type>::write(Ostream& os) const
139 {
140  fixedGradientFvPatchField<Type>::write(os);
141  uniformGradient_->writeData(os);
142  this->writeEntry("value", os);
143 }
144 
145 
146 // ************************************************************************* //
p
volScalarField & p
Definition: createFieldRefs.H:8
Foam::word
A class for handling words, derived from Foam::string.
Definition: word.H:65
Foam::Field
Generic templated field type.
Definition: Field.H:63
Foam::fvPatch
A finiteVolume patch using a polyPatch and a fvBoundaryMesh.
Definition: fvPatch.H:65
uniformFixedGradientFvPatchField.H
fld
gmvFile<< "tracers "<< particles.size()<< nl;for(const passiveParticle &p :particles){ gmvFile<< p.position().x()<< ' ';}gmvFile<< nl;for(const passiveParticle &p :particles){ gmvFile<< p.position().y()<< ' ';}gmvFile<< nl;for(const passiveParticle &p :particles){ gmvFile<< p.position().z()<< ' ';}gmvFile<< nl;for(const word &name :lagrangianScalarNames){ IOField< scalar > fld(IOobject(name, runTime.timeName(), cloud::prefix, mesh, IOobject::MUST_READ, IOobject::NO_WRITE))
Definition: gmvOutputLagrangian.H:23
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::PatchFunction1
Top level data entry class for use in dictionaries. Provides a mechanism to specify a variable as a c...
Definition: PatchFunction1.H:60
Foam::uniformFixedGradientFvPatchField
This boundary condition provides a uniform fixed gradient condition.
Definition: uniformFixedGradientFvPatchField.H:90
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::fixedGradientFvPatchField
This boundary condition supplies a fixed gradient condition, such that the patch values are calculate...
Definition: fixedGradientFvPatchField.H:108
Foam::uniformFixedGradientFvPatchField::write
virtual void write(Ostream &os) const
Write.
Definition: uniformFixedGradientFvPatchField.C:138
Foam::uniformFixedGradientFvPatchField::uniformFixedGradientFvPatchField
uniformFixedGradientFvPatchField(const fvPatch &, const DimensionedField< Type, volMesh > &)
Construct from patch and internal field.
Definition: uniformFixedGradientFvPatchField.C:35
Foam::uniformFixedGradientFvPatchField::updateCoeffs
virtual void updateCoeffs()
Update the coefficients associated with the patch field.
Definition: uniformFixedGradientFvPatchField.C:123
Foam::DimensionedField
Field with dimensions and associated with geometry type GeoMesh which is used to size the field and a...
Definition: DimensionedField.H:54
Foam::stringOps::evaluate
string evaluate(label fieldWidth, const std::string &s, size_t pos=0, size_t len=std::string::npos)
String evaluation with specified (positive, non-zero) field width.
Definition: stringOpsEvaluate.C:37