slicedFaPatchField.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 OpenFOAM Foundation
9  Copyright (C) 2023 OpenCFD Ltd.
10 -------------------------------------------------------------------------------
11 License
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 "slicedFaPatchField.H"
30 
31 // * * * * * * * * * * * * * * * Member Functions * * * * * * * * * * * * * //
32 
33 template<class Type>
35 (
36  const faPatch& p,
38  const Field<Type>& completeOrBoundaryField,
39  const bool isBoundaryOnly
40 )
41 :
42  faPatchField<Type>(p, iF, Field<Type>())
43 {
44  if (isBoundaryOnly)
45  {
46  // Set to a slice of the boundary field
47  UList<Type>::shallowCopy(p.boundarySlice(completeOrBoundaryField));
48  }
49  else
50  {
51  // Set to a slice of the complete field
52  UList<Type>::shallowCopy(p.patchSlice(completeOrBoundaryField));
53  }
54 }
55 
56 
57 template<class Type>
59 (
60  const faPatch& p,
61  const DimensionedField<Type, areaMesh>& iF
62 )
63 :
64  faPatchField<Type>(p, iF, Field<Type>())
65 {}
66 
67 
68 template<class Type>
70 (
71  const faPatch& p,
73  const dictionary& dict
74 )
75 :
76  faPatchField<Type>(p, iF) // bypass dictionary constructor
77 {
79  // Read "value" if present...
80 
82 }
83 
84 
85 template<class Type>
87 (
88  const slicedFaPatchField<Type>& ptf,
89  const faPatch& p,
91  const faPatchFieldMapper& mapper
92 )
93 :
94  faPatchField<Type>(ptf, p, iF, mapper)
95 {
97 }
98 
99 
100 template<class Type>
102 (
103  const slicedFaPatchField<Type>& ptf,
105 )
106 :
107  faPatchField<Type>(ptf.patch(), iF, Field<Type>())
108 {
109  // Transfer the slice from the argument
111 }
112 
113 
114 template<class Type>
116 (
117  const slicedFaPatchField<Type>& ptf
118 )
119 :
120  slicedFaPatchField<Type>(ptf, ptf.internalField())
121 {}
122 
123 
124 // * * * * * * * * * * * * * * * * Destructor * * * * * * * * * * * * * * * //
125 
126 template<class Type>
128 {
129  // Set to nullptr to avoid deletion of underlying field
131 }
132 
133 
134 // * * * * * * * * * * * * * * * Member Functions * * * * * * * * * * * * * //
135 
136 template<class Type>
138 {
140  return nullptr;
141 }
142 
143 
144 template<class Type>
147 {
149  return nullptr;
150 }
151 
152 
153 template<class Type>
155 {
157 }
158 
159 
160 template<class Type>
163 (
164  const Field<Type>& iField
165 ) const
166 {
168  return nullptr;
169 }
170 
171 
172 template<class Type>
175 {
177  return nullptr;
178 }
179 
180 
181 template<class Type>
184 (
185  const tmp<scalarField>&
186 ) const
187 {
189  return nullptr;
190 }
191 
192 
193 template<class Type>
196 (
197  const tmp<scalarField>&
198 ) const
199 {
201  return nullptr;
202 }
203 
204 
205 template<class Type>
208 {
210  return nullptr;
211 }
212 
213 
214 template<class Type>
217 {
219  return nullptr;
220 }
221 
222 
223 template<class Type>
225 {
228 }
229 
230 
231 // ************************************************************************* //
dictionary dict
virtual tmp< Field< Type > > patchInternalField() const
Return internal field next to patch as patch field.
Specialization of faPatchField which creates the underlying faPatchField as a slice of the given comp...
virtual void write(Ostream &os) const
Write.
Definition: faPatchField.C:253
A list of keyword definitions, which are a keyword followed by a number of values (eg...
Definition: dictionary.H:129
virtual tmp< Field< Type > > patchNeighbourField() const
Return patchField of the values on the patch or on the.
virtual void readDict(const dictionary &dict)
Read dictionary entries.
void writeValueEntry(Ostream &os) const
Write *this field as a "value" entry.
Definition: faPatchField.H:345
faPatchField<Type> abstract base class. This class gives a fat-interface to all derived classes cover...
Definition: areaFieldsFwd.H:46
virtual tmp< Field< Type > > valueInternalCoeffs(const tmp< scalarField > &) const
Return the matrix diagonal coefficients corresponding to the.
Generic templated field type.
Definition: Field.H:62
virtual tmp< Field< Type > > gradientBoundaryCoeffs() const
Return the matrix source coefficients corresponding to the.
An Ostream is an abstract base class for all output systems (streams, files, token lists...
Definition: Ostream.H:56
OBJstream os(runTime.globalPath()/outputName)
Finite area patch class. Used for 2-D non-Euclidian finite area method.
Definition: faPatch.H:72
virtual ~slicedFaPatchField()
Destructor, resets pointers to avoid deletion of underlying field.
virtual void write(Ostream &) const
Write.
Field with dimensions and associated with geometry type GeoMesh which is used to size the field and a...
void shallowCopy(T *__restrict__ ptr, const label len) noexcept
Copy the pointer and size.
Definition: UListI.H:309
const std::string patch
OpenFOAM patch number as a std::string.
virtual tmp< Field< Type > > valueBoundaryCoeffs(const tmp< scalarField > &) const
Return the matrix source coefficients corresponding to the.
virtual tmp< Field< Type > > snGrad() const
Return patch-normal gradient.
virtual tmp< Field< Type > > gradientInternalCoeffs() const
Return the matrix diagonal coefficients corresponding to the.
slicedFaPatchField(const faPatch &, const DimensionedField< Type, areaMesh > &, const Field< Type > &completeOrBoundaryField, const bool isBoundaryOnly=false)
Construct from patch, internal field and field to slice.
volScalarField & p
A class for managing temporary objects.
Definition: HashPtrTable.H:50
A FieldMapper for finite-area patch fields.
#define NotImplemented
Issue a FatalErrorIn for a function not currently implemented.
Definition: error.H:696