filmPyrolysisVelocityCoupledFvPatchVectorField.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 | Copyright (C) 2011-2013 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 
28 #include "surfaceFields.H"
29 #include "pyrolysisModel.H"
30 #include "surfaceFilmModel.H"
31 
32 // * * * * * * * * * * * * * * * * Constructors * * * * * * * * * * * * * * //
33 
36 (
37  const fvPatch& p,
39 )
40 :
41  fixedValueFvPatchVectorField(p, iF),
42  filmRegionName_("surfaceFilmProperties"),
43  pyrolysisRegionName_("pyrolysisProperties"),
44  phiName_("phi"),
45  rhoName_("rho")
46 {}
47 
48 
51 (
53  const fvPatch& p,
55  const fvPatchFieldMapper& mapper
56 )
57 :
58  fixedValueFvPatchVectorField(ptf, p, iF, mapper),
59  filmRegionName_(ptf.filmRegionName_),
60  pyrolysisRegionName_(ptf.pyrolysisRegionName_),
61  phiName_(ptf.phiName_),
62  rhoName_(ptf.rhoName_)
63 {}
64 
65 
68 (
69  const fvPatch& p,
71  const dictionary& dict
72 )
73 :
74  fixedValueFvPatchVectorField(p, iF),
75  filmRegionName_
76  (
77  dict.lookupOrDefault<word>("filmRegion", "surfaceFilmProperties")
78  ),
79  pyrolysisRegionName_
80  (
81  dict.lookupOrDefault<word>("pyrolysisRegion", "pyrolysisProperties")
82  ),
83  phiName_(dict.lookupOrDefault<word>("phi", "phi")),
84  rhoName_(dict.lookupOrDefault<word>("rho", "rho"))
85 {
86  fvPatchVectorField::operator=(vectorField("value", dict, p.size()));
87 }
88 
89 
92 (
94 )
95 :
96  fixedValueFvPatchVectorField(fpvpvf),
97  filmRegionName_(fpvpvf.filmRegionName_),
98  pyrolysisRegionName_(fpvpvf.pyrolysisRegionName_),
99  phiName_(fpvpvf.phiName_),
100  rhoName_(fpvpvf.rhoName_)
101 {}
102 
103 
106 (
109 )
110 :
111  fixedValueFvPatchVectorField(fpvpvf, iF),
112  filmRegionName_(fpvpvf.filmRegionName_),
113  pyrolysisRegionName_(fpvpvf.pyrolysisRegionName_),
114  phiName_(fpvpvf.phiName_),
115  rhoName_(fpvpvf.rhoName_)
116 {}
117 
118 
119 // * * * * * * * * * * * * * * * Member Functions * * * * * * * * * * * * * //
120 
122 {
123  if (updated())
124  {
125  return;
126  }
127 
130 
131  // Since we're inside initEvaluate/evaluate there might be processor
132  // comms underway. Change the tag we use.
133  int oldTag = UPstream::msgType();
134  UPstream::msgType() = oldTag+1;
135 
136  bool foundFilm = db().time().foundObject<filmModelType>(filmRegionName_);
137 
138  bool foundPyrolysis =
139  db().time().foundObject<pyrModelType>(pyrolysisRegionName_);
140 
141  if (!foundFilm || !foundPyrolysis)
142  {
143  // do nothing on construction - film model doesn't exist yet
144  return;
145  }
146 
147  vectorField& Up = *this;
148 
149  const label patchI = patch().index();
150 
151  // Retrieve film model
152  const filmModelType& filmModel =
153  db().time().lookupObject<filmModelType>(filmRegionName_);
154 
155  const label filmPatchI = filmModel.regionPatchID(patchI);
156 
157  scalarField alphaFilm = filmModel.alpha().boundaryField()[filmPatchI];
158  filmModel.toPrimary(filmPatchI, alphaFilm);
159 
160  vectorField UFilm = filmModel.Us().boundaryField()[filmPatchI];
161  filmModel.toPrimary(filmPatchI, UFilm);
162 
163  // Retrieve pyrolysis model
164  const pyrModelType& pyrModel =
165  db().time().lookupObject<pyrModelType>(pyrolysisRegionName_);
166 
167  const label pyrPatchI = pyrModel.regionPatchID(patchI);
168 
169  scalarField phiPyr = pyrModel.phiGas().boundaryField()[pyrPatchI];
170  pyrModel.toPrimary(pyrPatchI, phiPyr);
171 
172 
173  const surfaceScalarField& phi =
174  db().lookupObject<surfaceScalarField>(phiName_);
175 
176  if (phi.dimensions() == dimVelocity*dimArea)
177  {
178  // do nothing
179  }
180  else if (phi.dimensions() == dimDensity*dimVelocity*dimArea)
181  {
182  const fvPatchField<scalar>& rhop =
183  patch().lookupPatchField<volScalarField, scalar>(rhoName_);
184  phiPyr /= rhop;
185  }
186  else
187  {
189  (
190  "filmPyrolysisVelocityCoupledFvPatchVectorField::updateCoeffs()"
191  ) << "Unable to process flux field phi with dimensions "
192  << phi.dimensions() << nl
193  << " on patch " << patch().name()
194  << " of field " << dimensionedInternalField().name()
195  << " in file " << dimensionedInternalField().objectPath()
196  << exit(FatalError);
197  }
198 
199  const scalarField UAvePyr(-phiPyr/patch().magSf());
200  const vectorField& nf = patch().nf();
201 
202 
203  // Evaluate velocity
204  Up = alphaFilm*UFilm + (1.0 - alphaFilm)*UAvePyr*nf;
205 
206  // Restore tag
207  UPstream::msgType() = oldTag;
208 
209  fixedValueFvPatchVectorField::updateCoeffs();
210 }
211 
212 
214 (
215  Ostream& os
216 ) const
217 {
219  writeEntryIfDifferent<word>
220  (
221  os,
222  "filmRegion",
223  "surfaceFilmProperties",
224  filmRegionName_
225  );
226  writeEntryIfDifferent<word>
227  (
228  os,
229  "pyrolysisRegion",
230  "pyrolysisProperties",
231  pyrolysisRegionName_
232  );
233  writeEntryIfDifferent<word>(os, "phi", "phi", phiName_);
234  writeEntryIfDifferent<word>(os, "rho", "rho", rhoName_);
235  writeEntry("value", os);
236 }
237 
238 
239 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
240 
241 namespace Foam
242 {
244  (
247  );
248 }
249 
250 
251 // ************************************************************************* //
Foam::surfaceFields.
Field with dimensions and associated with geometry type GeoMesh which is used to size the field and a...
const dimensionSet dimArea(sqr(dimLength))
Definition: dimensionSets.H:57
A class for handling words, derived from string.
Definition: word.H:59
intWM_LABEL_SIZE_t label
A label is an int32_t or int64_t as specified by the pre-processor macro WM_LABEL_SIZE.
Definition: label.H:59
errorManipArg< error, int > exit(error &err, const int errNo=1)
Definition: errorManip.H:124
Foam::fvPatchFieldMapper.
const dimensionSet dimDensity
A list of keyword definitions, which are a keyword followed by any number of values (e...
Definition: dictionary.H:137
virtual void write(Ostream &) const
Write.
Definition: fvPatchField.C:354
Namespace for OpenFOAM.
static const char nl
Definition: Ostream.H:260
volVectorField vectorField(fieldObject, mesh)
GeometricField< scalar, fvPatchField, volMesh > volScalarField
Definition: volFieldsFwd.H:52
static int & msgType()
Message tag of standard messages.
Definition: UPstream.H:451
Macros for easy insertion into run-time selection tables.
const dimensionSet & dimensions() const
Return dimensions.
Abstract base class with a fat-interface to all derived classes covering all possible ways in which t...
Definition: fvPatchField.H:65
surfaceScalarField & phi
#define FatalErrorIn(functionName)
Report an error message using Foam::FatalError.
Definition: error.H:314
rDeltaT dimensionedInternalField()
error FatalError
T lookupOrDefault(const word &, const T &, bool recursive=false, bool patternMatch=true) const
Find and return a T,.
An Ostream is an abstract base class for all output systems (streams, files, token lists...
Definition: Ostream.H:53
filmPyrolysisVelocityCoupledFvPatchVectorField(const fvPatch &, const DimensionedField< vector, volMesh > &)
Construct from patch and internal field.
A finiteVolume patch using a polyPatch and a fvBoundaryMesh.
Definition: fvPatch.H:61
makePatchTypeField(fvPatchVectorField, SRFFreestreamVelocityFvPatchVectorField)
This boundary condition is designed to be used in conjunction with surface film and pyrolysis modelli...
virtual void updateCoeffs()
Update the coefficients associated with the patch field.
virtual label size() const
Return size.
Definition: fvPatch.H:161
const dimensionSet dimVelocity