internalFvPatchField.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) 2021 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 
26 #include "internalFvPatchField.H"
27 #include "fvPatchFieldMapper.H"
28 
29 // * * * * * * * * * * * * * * * * Constructors * * * * * * * * * * * * * * //
30 
31 template<class Type>
33 (
34  const fvPatch& p,
36 )
37 :
39 {}
40 
41 
42 template<class Type>
44 (
45  const fvPatch& p,
47  const dictionary& dict
48 )
49 :
50  fvPatchField<Type>(p, iF, dict, false)
51 {
52  if (!isType<internalFvPatch>(p))
53  {
55  (
56  dict
57  ) << "\n patch type '" << p.type()
58  << "' not constraint type '" << typeName << "'"
59  << "\n for patch " << p.name()
60  << " of field " << this->internalField().name()
61  << " in file " << this->internalField().objectPath()
62  << exit(FatalIOError);
63  }
64 
65  fvPatchField<Type>::operator=(this->patchInternalField());
66 }
67 
68 
69 template<class Type>
71 (
72  const internalFvPatchField<Type>& ptf,
73  const fvPatch& p,
75  const fvPatchFieldMapper& mapper
76 )
77 :
78  fvPatchField<Type>(ptf, p, iF, mapper)
79 {
80  if (!isType<internalFvPatch>(p))
81  {
83  << "' not constraint type '" << typeName << "'"
84  << "\n for patch " << p.name()
85  << " of field " << this->internalField().name()
86  << " in file " << this->internalField().objectPath()
87  << exit(FatalError);
88  }
89 }
90 
91 
92 template<class Type>
94 (
95  const internalFvPatchField<Type>& ptf,
97 )
98 :
99  fvPatchField<Type>(ptf, iF)
100 {}
101 
102 
103 // * * * * * * * * * * * * * * * Member Functions * * * * * * * * * * * * * //
104 
105 template<class Type>
107 {
108  if (!this->updated())
109  {
110  this->updateCoeffs();
111  }
112 
113  fvPatchField<Type>::operator==(this->patchInternalField());
115 }
116 
117 
118 template<class Type>
121 (
122  const tmp<scalarField>&
123 ) const
124 {
125  if (this->patch().size())
126  {
128  << "attempt to create matrix coefficients for field "
129  << this->internalField().name()
130  << " on non-empty '" << typeName << "' patch "
131  << this->patch().name()
132  << exit(FatalError);
133  }
134 
135  return tmp<Field<Type>>(new Field<Type>(0));
136 }
137 
138 
139 template<class Type>
142 (
143  const tmp<scalarField>&
144 ) const
145 {
146  if (this->patch().size())
147  {
149  << "attempt to create matrix coefficients for field "
150  << this->internalField().name()
151  << " on non-empty '" << typeName << "' patch "
152  << this->patch().name()
153  << exit(FatalError);
154  }
155 
156  return tmp<Field<Type>>(new Field<Type>(0));
157 }
158 
159 
160 template<class Type>
163 {
164  if (this->patch().size())
165  {
167  << "attempt to create matrix coefficients for field "
168  << this->internalField().name()
169  << " on non-empty '" << typeName << "' patch "
170  << this->patch().name()
171  << exit(FatalError);
172  }
173 
174  return tmp<Field<Type>>(new Field<Type>(0));
175 }
176 
177 
178 template<class Type>
181 {
182  if (this->patch().size())
183  {
185  << "attempt to create matrix coefficients for field "
186  << this->internalField().name()
187  << " on non-empty '" << typeName << "' patch "
188  << this->patch().name()
189  << exit(FatalError);
190  }
191 
192  return tmp<Field<Type>>(new Field<Type>(0));
193 }
194 
195 
196 // ************************************************************************* //
dictionary dict
virtual tmp< Field< Type > > gradientBoundaryCoeffs() const
Return the matrix source coefficients corresponding to the.
errorManipArg< error, int > exit(error &err, const int errNo=1)
Definition: errorManip.H:124
void evaluate(GeometricField< Type, PatchField, GeoMesh > &result, const Function1< Type > &func, const GeometricField< Type, PatchField, GeoMesh > &x)
error FatalError
A list of keyword definitions, which are a keyword followed by any number of values (e...
Definition: dictionary.H:156
#define FatalErrorInFunction
Report an error message using Foam::FatalError.
Definition: error.H:323
commsTypes
Types of communications.
Definition: UPstream.H:64
internalFvPatchField(const fvPatch &, const DimensionedField< Type, volMesh > &)
Construct from patch and internal field.
A finiteVolume patch using a polyPatch and a fvBoundaryMesh.
Definition: fvPatch.H:62
Abstract base class with a fat-interface to all derived classes covering all possible ways in which t...
Definition: fvPatchField.H:66
virtual tmp< Field< Type > > valueInternalCoeffs(const tmp< scalarField > &) const
Return the matrix diagonal coefficients corresponding to the.
virtual void evaluate(const Pstream::commsTypes commsType=Pstream::commsTypes::blocking)
Evaluate the patch field.
Pre-declare SubField and related Field type.
Definition: Field.H:56
tmp< fvMatrix< Type > > operator==(const fvMatrix< Type > &, const fvMatrix< Type > &)
Foam::fvPatchFieldMapper.
virtual tmp< Field< Type > > valueBoundaryCoeffs(const tmp< scalarField > &) const
Return the matrix source coefficients corresponding to the.
virtual tmp< Field< Type > > gradientInternalCoeffs() const
Return the matrix diagonal coefficients corresponding to the.
#define FatalIOErrorInFunction(ios)
Report an error message using Foam::FatalIOError.
Definition: error.H:335
Field with dimensions and associated with geometry type GeoMesh which is used to size the field and a...
volScalarField & p
A class for managing temporary objects.
Definition: PtrList.H:53
Constraint fvPatchField to hold values for internal face exposed by sub-setting.
IOerror FatalIOError