genericFaePatchField.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) 2023 OpenCFD 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 
29 #include "faPatchFieldMapper.H"
30 
31 // * * * * * * * * * * * * * * * * Constructors * * * * * * * * * * * * * * //
32 
33 template<class Type>
35 (
36  const faPatch& p,
38 )
39 :
40  parent_bctype(p, iF)
41 {
43  << "Trying to construct generic patchField on patch "
44  << this->patch().name()
45  << " of field " << this->internalField().name()
46  << abort(FatalError);
47 }
48 
49 
50 template<class Type>
52 (
53  const faPatch& p,
55  const dictionary& dict
56 )
57 :
58  parent_bctype(p, iF, dict),
60 {
61  const label patchSize = this->size();
62  const word& patchName = this->patch().name();
63  const IOobject& io = this->internalField();
64 
65  if (!dict.findEntry("value", keyType::LITERAL))
66  {
67  reportMissingEntry("value", patchName, io);
68  }
69 
70  // Handle "value" separately
71  processGeneric(patchSize, patchName, io, true);
72 }
73 
74 
75 template<class Type>
77 (
78  const genericFaePatchField<Type>& rhs,
79  const faPatch& p,
81  const faPatchFieldMapper& mapper
82 )
83 :
84  parent_bctype(rhs, p, iF, mapper),
86 {
87  this->mapGeneric(rhs, mapper);
88 }
89 
90 
91 template<class Type>
93 (
94  const genericFaePatchField<Type>& rhs,
96 )
97 :
98  parent_bctype(rhs, iF),
100 {}
101 
102 
103 // * * * * * * * * * * * * * * * Member Functions * * * * * * * * * * * * * //
104 
105 template<class Type>
107 {
108  // Handle "value" separately
111 }
112 
113 
114 template<class Type>
116 (
117  const faPatchFieldMapper& m
118 )
119 {
120  parent_bctype::autoMap(m);
121  this->autoMapGeneric(m);
122 }
123 
124 
125 template<class Type>
127 (
128  const faePatchField<Type>& rhs,
129  const labelList& addr
130 )
131 {
132  parent_bctype::rmap(rhs, addr);
133 
134  const auto* base = isA<genericPatchFieldBase>(rhs);
135  if (base)
136  {
137  this->rmapGeneric(*base, addr);
138  }
139 }
140 
141 
142 // ************************************************************************* //
dictionary dict
virtual void write(Ostream &) const
Write.
error FatalError
Error stream (stdout output on all processes), with additional &#39;FOAM FATAL ERROR&#39; header text and sta...
A list of keyword definitions, which are a keyword followed by a number of values (eg...
Definition: dictionary.H:129
#define FatalErrorInFunction
Report an error message using Foam::FatalError.
Definition: error.H:598
void writeGeneric(Ostream &os, const bool separateValue) const
Write all generic entries from dictionary, optionally treating the "value" entry separately.
This boundary condition provides a generic version of the calculated condition, useful as a fallback ...
const DimensionedField< Type, edgeMesh > & internalField() const noexcept
Return const-reference to the dimensioned internal field.
void reportMissingEntry(const word &entryName, const word &patchName, const IOobject &io) const
FatalError for missing entry.
virtual void autoMap(const faPatchFieldMapper &)
Map (and resize as needed) from self given a mapping object.
A class for handling words, derived from Foam::string.
Definition: word.H:63
void processGeneric(const label patchSize, const word &patchName, const IOobject &io, const bool separateValue)
const faPatch & patch() const noexcept
Return the patch.
String literal.
Definition: keyType.H:82
errorManip< error > abort(error &err)
Definition: errorManip.H:139
const word & name() const noexcept
The patch name.
An Ostream is an abstract base class for all output systems (streams, files, token lists...
Definition: Ostream.H:56
label size() const noexcept
The number of elements in the container.
Definition: UList.H:671
OBJstream os(runTime.globalPath()/outputName)
Finite area patch class. Used for 2-D non-Euclidian finite area method.
Definition: faPatch.H:72
virtual void rmap(const faePatchField< Type > &, const labelList &)
Reverse map the given faPatchField onto this faPatchField.
Generic infrastructure for reading/writing unknown patch types.
Field with dimensions and associated with geometry type GeoMesh which is used to size the field and a...
Definition: areaFieldsFwd.H:42
void writeValueEntry(Ostream &os) const
Write *this field as a "value" entry.
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
A class representing the concept of 0 (zero) that can be used to avoid manipulating objects known to ...
Definition: zero.H:57
genericFaePatchField(const faPatch &, const DimensionedField< Type, edgeMesh > &)
Construct from patch and internal field.
faePatchField<Type> abstract base class. This class gives a fat-interface to all derived classes cove...
Definition: edgeFieldsFwd.H:46
volScalarField & p
IOobject io("surfaceFilmProperties", mesh.time().constant(), mesh, IOobject::READ_IF_PRESENT, IOobject::NO_WRITE, IOobject::NO_REGISTER)
A FieldMapper for finite-area patch fields.
Defines the attributes of an object for which implicit objectRegistry management is supported...
Definition: IOobject.H:172
Author Zeljko Tukovic, FMENA Hrvoje Jasak, Wikki Ltd.