clampedPlateFaPatchField.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) 2020 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 "areaFields.H"
32 
33 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
34 
35 namespace Foam
36 {
37 
38 // * * * * * * * * * * * * * * * Member Functions * * * * * * * * * * * * * //
39 
40 template<class Type>
42 (
43  const faPatch& p,
45 )
46 :
47  faPatchField<Type>(p, iF)
48 {}
49 
50 
51 template<class Type>
53 (
54  const faPatch& p,
56  const dictionary& dict
57 )
58 :
59  faPatchField<Type>(p, iF, dict, IOobjectOption::NO_READ)
60 {
61  this->extrapolateInternal(); // Zero-gradient patch values
62 }
63 
64 
65 template<class Type>
67 (
69  const faPatch& p,
71  const faPatchFieldMapper& mapper
72 )
73 :
74  faPatchField<Type>(ptf, p, iF, mapper)
75 {}
76 
77 
78 template<class Type>
80 (
82 )
83 :
84  faPatchField<Type>(ptf)
85 {}
86 
87 
88 template<class Type>
90 (
93 )
94 :
95  faPatchField<Type>(ptf, iF)
96 {}
97 
98 
99 // * * * * * * * * * * * * * * * Member Functions * * * * * * * * * * * * * //
100 
101 template<class Type>
103 {
104  notImplemented(type() + "::evaluate(const Pstream::commsType)");
105 }
106 
107 
108 template<>
110 {
111  if (!this->updated())
112  {
113  this->updateCoeffs();
114  }
115 
117 
118  auto& iF = const_cast<Field<scalar>&>(this->primitiveField());
119 
120  for (const label facei : this->patch().edgeFaces())
121  {
122  iF[facei] = Zero;
123  }
126 }
127 
128 
129 template<class Type>
131 (
132  const tmp<scalarField>&
133 ) const
134 {
135  return tmp<Field<Type>>::New(this->size(), Zero);
136 }
137 
138 
139 template<class Type>
141 (
142  const tmp<scalarField>&
143 ) const
144 {
145  return *this;
146 }
147 
148 
149 template<class Type>
152 {
153  return -Type(pTraits<Type>::one)*this->patch().deltaCoeffs();
154 }
155 
156 
157 template<class Type>
160 {
161  return this->patch().deltaCoeffs()*(*this);
162 }
163 
164 
165 template<class Type>
167 {
170 }
171 
172 
173 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
174 
175 } // End namespace Foam
176 
177 // ************************************************************************* //
dictionary dict
virtual void write(Ostream &os) const
Write.
Definition: faPatchField.C:253
commsTypes
Communications types.
Definition: UPstream.H:72
A list of keyword definitions, which are a keyword followed by a number of values (eg...
Definition: dictionary.H:129
Various UniformDimensionedField types.
A traits class, which is primarily used for primitives and vector-space.
Definition: pTraits.H:75
tmp< DimensionedField< TypeR, GeoMesh > > New(const tmp< DimensionedField< TypeR, GeoMesh >> &tf1, const word &name, const dimensionSet &dimensions, const bool initCopy=false)
Global function forwards to reuseTmpDimensionedField::New.
void writeValueEntry(Ostream &os) const
Write *this field as a "value" entry.
Definition: faPatchField.H:317
virtual void write(Ostream &) const
Write.
faPatchField<Type> abstract base class. This class gives a fat-interface to all derived classes cover...
Definition: areaFieldsFwd.H:56
Macros for easy insertion into run-time selection tables.
virtual void evaluate(const Pstream::commsTypes commsType=Pstream::commsTypes::blocking)
Evaluate the patch field.
fileName::Type type(const fileName &name, const bool followLink=true)
Return the file type: DIRECTORY or FILE, normally following symbolic links.
Definition: POSIX.C:799
virtual tmp< Field< Type > > gradientBoundaryCoeffs() const
Return the matrix source coefficients corresponding to the evaluation of the gradient of this patchFi...
This BC provides a clamped BC. It sets zero fixed value and zeroGradient.
An Ostream is an abstract base class for all output systems (streams, files, token lists...
Definition: Ostream.H:56
OBJstream os(runTime.globalPath()/outputName)
void operator=(const Field< Type > &)
Copy assignment.
Definition: Field.C:747
Finite area patch class. Used for 2-D non-Euclidian finite area method.
Definition: faPatch.H:72
virtual tmp< Field< Type > > valueInternalCoeffs(const tmp< scalarField > &) const
Return the matrix diagonal coefficients corresponding to the evaluation of the value of this patchFie...
virtual tmp< Field< Type > > gradientInternalCoeffs() const
Return the matrix diagonal coefficients corresponding to the evaluation of the gradient of this patch...
virtual void evaluate(const Pstream::commsTypes commsType=Pstream::commsTypes::blocking)
Evaluate the patch field, sets updated() to false.
Definition: faPatchField.C:241
#define notImplemented(functionName)
Issue a FatalErrorIn for a function not currently implemented.
Definition: error.H:673
clampedPlateFaPatchField(const faPatch &, const DimensionedField< Type, areaMesh > &)
Construct from patch and internal field.
A simple container of IOobject preferences. Can also be used for general handling of read/no-read/rea...
Field with dimensions and associated with geometry type GeoMesh which is used to size the field and a...
Definition: areaFieldsFwd.H:42
const std::string patch
OpenFOAM patch number as a std::string.
volScalarField & p
A class for managing temporary objects.
Definition: HashPtrTable.H:50
A FieldMapper for finite-area patch fields.
Namespace for OpenFOAM.
static constexpr const zero Zero
Global zero (0)
Definition: zero.H:127
virtual tmp< Field< Type > > valueBoundaryCoeffs(const tmp< scalarField > &) const
Return the matrix source coefficients corresponding to the evaluation of the value of this patchField...