Loading...
Searching...
No Matches
genericFvPatchField.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\*---------------------------------------------------------------------------*/
29#include "genericFvPatchField.H"
30#include "fvPatchFieldMapper.H"
31
32// * * * * * * * * * * * * * * * * Constructors * * * * * * * * * * * * * * //
33
34template<class Type>
36(
37 const fvPatch& p,
39)
40:
41 parent_bctype(p, iF)
42{
44 << "Trying to construct generic patchField on patch "
45 << this->patch().name()
46 << " of field " << this->internalField().name()
47 << abort(FatalError);
48}
49
50
51template<class Type>
53(
54 const fvPatch& 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.findEntry("value", keyType::LITERAL))
67 {
68 reportMissingEntry("value", patchName, io);
69 }
71 // Handle "value" separately
72 processGeneric(patchSize, patchName, io, true);
73}
74
75
76template<class Type>
78(
80 const fvPatch& p,
82 const fvPatchFieldMapper& 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
112}
113
114
115template<class Type>
117(
118 const fvPatchFieldMapper& m
119)
122 this->autoMapGeneric(m);
123}
124
125
126template<class Type>
128(
129 const fvPatchField<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 generic patchField";
152
153 genericFatalSolveError
154 (
155 this->patch().name(),
156 this->internalField()
157 );
160 return *this;
161}
162
163
164template<class Type>
167(
168 const tmp<scalarField>&
169) const
170{
172 << "Cannot be called for a generic patchField";
173
174 genericFatalSolveError
175 (
176 this->patch().name(),
177 this->internalField()
178 );
181 return *this;
182}
183
184
185template<class Type>
188{
190 << "Cannot be called for a generic patchField";
191
192 genericFatalSolveError
193 (
194 this->patch().name(),
195 this->internalField()
196 );
198
199 return *this;
200}
201
202template<class Type>
205{
207 << "Cannot be called for a generic patchField";
208
209 genericFatalSolveError
210 (
211 this->patch().name(),
212 this->internalField()
213 );
215
216 return *this;
217}
218
219
220// ************************************************************************* //
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:191
const word & name() const noexcept
Return the object name.
Definition IOobjectI.H:205
An Ostream is an abstract base class for all output systems (streams, files, token lists,...
Definition Ostream.H:59
void size(const label n)
Definition UList.H:118
A list of keyword definitions, which are a keyword followed by a number of values (eg,...
Definition dictionary.H:133
const entry * findEntry(const word &keyword, enum keyType::option matchOpt=keyType::REGEX) const
Find an entry (const access) with the given keyword.
Definition dictionaryI.H:84
const fvPatch & patch() const noexcept
Return the patch.
A FieldMapper for finite-volume patch fields.
Abstract base class with a fat-interface to all derived classes covering all possible ways in which t...
virtual void autoMap(const fvPatchFieldMapper &)
Map (and resize as needed) from self given a mapping object.
void writeValueEntry(Ostream &os) const
Write *this field as a "value" entry.
const DimensionedField< Type, volMesh > & internalField() const noexcept
Return const-reference to the dimensioned internal field.
virtual void rmap(const fvPatchField< Type > &, const labelList &)
Reverse map the given fvPatchField onto this fvPatchField.
A finiteVolume patch using a polyPatch and a fvBoundaryMesh.
Definition fvPatch.H:71
virtual const word & name() const
Return name.
Definition fvPatch.H:210
This boundary condition provides a generic version of the calculated condition, useful as a fallback ...
virtual void autoMap(const fvPatchFieldMapper &)
Map (and resize as needed) from self given a mapping object.
virtual void write(Ostream &) const
Write.
tmp< Field< Type > > gradientInternalCoeffs() const
Fatal.
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.
genericFvPatchField(const fvPatch &, const DimensionedField< Type, volMesh > &)
Construct from patch and internal field.
virtual void rmap(const fvPatchField< Type > &, const labelList &)
Reverse map the given fvPatchField onto this fvPatchField.
Generic infrastructure for reading/writing unknown patch types.
void writeGeneric(Ostream &os, const bool separateValue) const
Write all generic entries from dictionary, optionally treating the "value" entry separately.
void rmapGeneric(const genericPatchFieldBase &rhs, const labelList &addr)
Implementation for reverse map given patch field onto this patch field.
void reportMissingEntry(const word &entryName, const word &patchName, const IOobject &io) const
FatalError for missing entry.
void autoMapGeneric(const MapperType &mapper)
Implementation for autoMap of self given a mapping object.
genericPatchFieldBase(const Foam::zero, const genericPatchFieldBase &)
Partial copy construct. Only copy type and dictionary.
void genericFatalSolveError(const word &patchName, const IOobject &io) const
Add error message to FatalError about solving with generic condition.
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.
@ LITERAL
String literal.
Definition keyType.H:82
A class for managing temporary objects.
Definition tmp.H:75
A class for handling words, derived from Foam::string.
Definition word.H:66
volScalarField & p
#define FatalErrorInFunction
Report an error message using Foam::FatalError.
Definition error.H:600
OBJstream os(runTime.globalPath()/outputName)
const auto & io
auto & name
List< label > labelList
A List of labels.
Definition List.H:62
const Type * isA(const U &obj)
Attempt dynamic_cast to Type.
Definition typeInfo.H:87
errorManip< error > abort(error &err)
Definition errorManip.H:139
void rhs(fvMatrix< typename Expr::value_type > &m, const Expr &expression)
error FatalError
Error stream (stdout output on all processes), with additional 'FOAM FATAL ERROR' header text and sta...
dictionary dict
A non-counting (dummy) refCount.
Definition refCount.H:55