emptyFaPatchField.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) 2016-2017 Wikki Ltd
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 "emptyFaPatchField.H"
30 #include "areaFaMesh.H"
31 
32 // * * * * * * * * * * * * * * * * Constructors * * * * * * * * * * * * * * //
33 
34 template<class Type>
36 (
37  const faPatch& p,
39 )
40 :
41  faPatchField<Type>(p, iF, Field<Type>()) // zero-sized patch field
42 {}
43 
44 
45 template<class Type>
47 (
49  const faPatch& p,
51  const faPatchFieldMapper&
52 )
53 :
54  faPatchField<Type>(p, iF, Field<Type>()) // zero-sized patch field
55 {
56  if (!isType<emptyFaPatch>(p))
57  {
59  << "\n patch type '" << p.type()
60  << "' not constraint type '" << typeName << "'"
61  << "\n for patch " << p.name()
62  << " of field " << this->internalField().name()
63  << " in file " << this->internalField().objectPath()
65  }
66 }
67 
68 
69 template<class Type>
71 (
72  const faPatch& p,
73  const DimensionedField<Type, areaMesh>& iF,
74  const dictionary& dict
75 )
76 :
77  faPatchField<Type>(p, iF, Field<Type>()) // zero-sized patch field
78 {
79  // Empty means empty, so no patchType override
80  // with faPatchFieldBase::readDict(dict);
81 
82  if (!isA<emptyFaPatch>(p))
83  {
85  << "\n patch type '" << p.type()
86  << "' not constraint type '" << typeName << "'"
87  << "\n for patch " << p.name()
88  << " of field " << this->internalField().name()
89  << " in file " << this->internalField().objectPath()
91  }
92 }
93 
94 
95 template<class Type>
97 (
98  const emptyFaPatchField<Type>& ptf,
99  const DimensionedField<Type, areaMesh>& iF
100 )
101 :
102  faPatchField<Type>(ptf.patch(), iF, Field<Type>()) // zero-sized
103 {}
104 
105 
106 template<class Type>
108 (
109  const emptyFaPatchField<Type>& ptf
110 )
111 :
112  emptyFaPatchField<Type>(ptf, ptf.internalField())
113 {}
114 
115 
116 // * * * * * * * * * * * * * * * Member Functions * * * * * * * * * * * * * //
117 
118 template<class Type>
120 {
121  if (this->internalField().mesh().nFaces())
122  {
123  if
124  (
125  this->patch().faPatch::size()
126  % this->internalField().mesh().nFaces()
127  )
128  {
130  << "This mesh contains patches of type empty but is "
131  << "not 1D or 2D by virtue of the fact that the number of "
132  << "faces of this empty patch is not divisible by the number "
133  << "of cells."
134  << exit(FatalError);
135  }
136  }
137 }
138 
139 
140 // * * * * * * * * * * * * * * * Member Functions * * * * * * * * * * * * * //
141 
142 template<class Type>
143 void Foam::emptyFaPatchField<Type>::write(Ostream& os) const
144 {
146  // Never write "value"
147 }
148 
149 
150 // ************************************************************************* //
virtual void write(Ostream &) const
Write without "value" entry!
dictionary dict
virtual void write(Ostream &os) const
Write.
Definition: faPatchField.C:253
errorManipArg< error, int > exit(error &err, const int errNo=1)
Definition: errorManip.H:125
error FatalError
Error stream (stdout output on all processes), with additional &#39;FOAM FATAL ERROR&#39; header text and sta...
#define FatalErrorInFunction
Report an error message using Foam::FatalError.
Definition: error.H:608
void updateCoeffs()
Update the coefficients associated with the patch field.
const DimensionedField< Type, areaMesh > & internalField() const noexcept
Return const-reference to the dimensioned internal field.
Definition: faPatchField.H:622
virtual label size() const
Patch size is the number of edge labels, but can be overloaded.
Definition: faPatch.H:392
faPatchField<Type> abstract base class. This class gives a fat-interface to all derived classes cover...
Definition: areaFieldsFwd.H:46
static const char *const typeName
Typename for Field.
Definition: Field.H:86
emptyFaPatchField(const faPatch &, const DimensionedField< Type, areaMesh > &)
Construct from patch and internal field.
dynamicFvMesh & mesh
Generic templated field type.
Definition: Field.H:62
Author Zeljko Tukovic, FMENA Hrvoje Jasak, Wikki Ltd.
OBJstream os(runTime.globalPath()/outputName)
Finite area patch class. Used for 2-D non-Euclidian finite area method.
Definition: faPatch.H:72
#define FatalIOErrorInFunction(ios)
Report an error message using Foam::FatalIOError.
Definition: error.H:637
Field with dimensions and associated with geometry type GeoMesh which is used to size the field and a...
const std::string patch
OpenFOAM patch number as a std::string.
volScalarField & p
A FieldMapper for finite-area patch fields.
IOerror FatalIOError
Error stream (stdout output on all processes), with additional &#39;FOAM FATAL IO ERROR&#39; header text and ...