genericFaPatchField.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) 2011-2016 OpenFOAM Foundation
9 Copyright (C) 2019-2021 OpenCFD Ltd.
10-------------------------------------------------------------------------------
11License
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 "genericFaPatchField.H"
30#include "faPatchFieldMapper.H"
31
32// * * * * * * * * * * * * * * * * Constructors * * * * * * * * * * * * * * //
33
34template<class Type>
36(
37 const faPatch& p,
39)
40:
41 parent_bctype(p, iF)
42{
44 << "Trying to construct genericFaPatchField on patch "
45 << this->patch().name()
46 << " of field " << this->internalField().name() << nl
47 << abort(FatalError);
48}
49
50
51template<class Type>
53(
54 const faPatch& p,
56 const dictionary& dict
57)
58:
59 parent_bctype(p, iF, dict),
61{
62 const label patchSize = this->size();
63 const word& patchName = this->patch().name();
64 const IOobject& io = this->internalField();
65
66 if (!dict.found("value"))
67 {
68 reportMissingEntry("value", patchName, io);
69 }
70
71 // Handle "value" separately
72 processGeneric(patchSize, patchName, io, true);
73}
74
75
76template<class Type>
78(
80 const faPatch& p,
82 const faPatchFieldMapper& mapper
83)
84:
85 parent_bctype(rhs, p, iF, mapper),
87{
88 this->mapGeneric(rhs, mapper);
89}
90
91
92template<class Type>
94(
97)
98:
99 parent_bctype(rhs, iF),
101{}
102
103
104// * * * * * * * * * * * * * * * Member Functions * * * * * * * * * * * * * //
105
106template<class Type>
108{
109 // Handle "value" separately
111 this->writeEntry("value", os);
112}
113
114
115template<class Type>
117(
118 const faPatchFieldMapper& m
119)
120{
121 parent_bctype::autoMap(m);
122 this->autoMapGeneric(m);
123}
124
125
126template<class Type>
128(
129 const faPatchField<Type>& rhs,
130 const labelList& addr
131)
132{
133 parent_bctype::rmap(rhs, addr);
134
135 const auto* base = isA<genericPatchFieldBase>(rhs);
136 if (base)
137 {
138 this->rmapGeneric(*base, addr);
139 }
140}
141
142
143template<class Type>
146(
147 const tmp<scalarField>&
148) const
149{
151 << "Cannot be called for a genericFaPatchField";
152
153 genericFatalSolveError
154 (
155 this->patch().name(),
156 this->internalField()
157 );
159
160 return *this;
161}
162
163
164template<class Type>
167(
168 const tmp<scalarField>&
169) const
170{
172 << "Cannot be called for a genericFaPatchField";
173
174 genericFatalSolveError
175 (
176 this->patch().name(),
177 this->internalField()
178 );
180
181 return *this;
182}
183
184
185template<class Type>
188{
190 << "Cannot be called for a genericFaPatchField";
191
192 genericFatalSolveError
193 (
194 this->patch().name(),
195 this->internalField()
196 );
198
199 return *this;
200}
201
202
203template<class Type>
206{
208 << "Cannot be called for a genericFaPatchField";
209
210 genericFatalSolveError
211 (
212 this->patch().name(),
213 this->internalField()
214 );
216
217 return *this;
218}
219
220
221// ************************************************************************* //
Field with dimensions and associated with geometry type GeoMesh which is used to size the field and a...
Defines the attributes of an object for which implicit objectRegistry management is supported,...
Definition: IOobject.H:170
An Ostream is an abstract base class for all output systems (streams, files, token lists,...
Definition: Ostream.H:62
label size() const noexcept
The number of elements in the UList.
Definition: UListI.H:420
Author Zeljko Tukovic, FMENA Hrvoje Jasak, Wikki Ltd.
A list of keyword definitions, which are a keyword followed by a number of values (eg,...
Definition: dictionary.H:126
bool found(const word &keyword, enum keyType::option matchOpt=keyType::REGEX) const
Search for an entry (const access) with the given keyword.
Definition: dictionaryI.H:87
A FieldMapper for finite-area patch fields.
faPatchField<Type> abstract base class. This class gives a fat-interface to all derived classes cover...
Definition: faPatchField.H:82
const faPatch & patch() const
Return patch.
Definition: faPatchField.H:286
const DimensionedField< Type, areaMesh > & internalField() const
Return dimensioned internal field reference.
Definition: faPatchField.H:292
Finite area patch class. Used for 2-D non-Euclidian finite area method.
Definition: faPatch.H:78
virtual bool write()
Write the output fields.
This boundary condition provides a generic version of the calculated condition, useful as a fallback ...
tmp< Field< Type > > gradientInternalCoeffs() const
Fatal.
virtual void rmap(const faPatchField< Type > &, const labelList &)
Reverse map the given faPatchField onto this faPatchField.
virtual tmp< Field< Type > > valueInternalCoeffs(const tmp< scalarField > &) const
Fatal.
tmp< Field< Type > > gradientBoundaryCoeffs() const
Fatal.
virtual tmp< Field< Type > > valueBoundaryCoeffs(const tmp< scalarField > &) const
Fatal.
virtual void autoMap(const faPatchFieldMapper &)
Map (and resize as needed) from self given a mapping object.
Generic infrastructure for reading/writing unknown patch types.
void writeGeneric(Ostream &os, const bool separateValue) const
void reportMissingEntry(const word &entryName, const word &patchName, const IOobject &io) const
FatalError for missing entry.
void processGeneric(const label patchSize, const word &patchName, const IOobject &io, const bool separateValue)
void mapGeneric(const genericPatchFieldBase &rhs, const MapperType &mapper)
Implementation for construct with mapper.
const word & name() const noexcept
The patch name.
A class for managing temporary objects.
Definition: tmp.H:65
A class for handling words, derived from Foam::string.
Definition: word.H:68
volScalarField & p
#define FatalErrorInFunction
Report an error message using Foam::FatalError.
Definition: error.H:453
OBJstream os(runTime.globalPath()/outputName)
IOobject io("surfaceFilmProperties", mesh.time().constant(), mesh, IOobject::READ_IF_PRESENT, IOobject::NO_WRITE, false)
errorManip< error > abort(error &err)
Definition: errorManip.H:144
error FatalError
word name(const expressions::valueTypeCode typeCode)
A word representation of a valueTypeCode. Empty for INVALID.
Definition: exprTraits.C:59
constexpr char nl
The newline '\n' character (0x0a)
Definition: Ostream.H:53
dictionary dict
A non-counting (dummy) refCount.
Definition: refCount.H:59