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)
60 {
61  faPatchField<Type>::operator=(this->patchInternalField());
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 
116  Field<scalar>::operator=(pTraits<scalar>::zero);
117 
118  const labelUList& edgeFaces = this->patch().edgeFaces();
119  forAll(edgeFaces, edgeID)
120  {
121  label faceID = edgeFaces[edgeID];
122  const_cast<Field<scalar>&>(this->primitiveField())[faceID] =
123  pTraits<scalar>::zero;
124  }
125 
127 }
128 
129 
130 template<class Type>
132 (
133  const tmp<scalarField>&
134 ) const
135 {
137  (new Field<Type>(this->size(), pTraits<Type>::zero));
138 }
139 
140 
141 template<class Type>
143 (
144  const tmp<scalarField>&
145 ) const
146 {
147  return *this;
148 }
149 
150 
151 template<class Type>
154 {
155  return -Type(pTraits<Type>::one)*this->patch().deltaCoeffs();
156 }
157 
158 
159 template<class Type>
162 {
163  return this->patch().deltaCoeffs()*(*this);
164 }
165 
166 
167 template<class Type>
169 {
171  this->writeEntry("value", os);
172 }
173 
174 
175 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
176 
177 } // End namespace Foam
178 
179 // ************************************************************************* //
Foam::clampedPlateFaPatchField::valueBoundaryCoeffs
virtual tmp< Field< Type > > valueBoundaryCoeffs(const tmp< scalarField > &) const
Definition: clampedPlateFaPatchField.C:136
p
volScalarField & p
Definition: createFieldRefs.H:8
Foam::faPatchField< Type >
Foam::faPatchField::write
virtual void write(Ostream &) const
Definition: faPatchField.C:200
Foam::tmp
A class for managing temporary objects.
Definition: PtrList.H:57
Foam::clampedPlateFaPatchField::write
virtual void write(Ostream &) const
Definition: clampedPlateFaPatchField.C:161
Foam::faPatchFieldMapper
Definition: faPatchFieldMapper.H:37
edgeID
label edgeID
Definition: boundaryProcessorFaPatchPoints.H:6
forAll
#define forAll(list, i)
Definition: stdFoam.H:349
Foam::clampedPlateFaPatchField::evaluate
virtual void evaluate(const Pstream::commsTypes commsType=Pstream::commsTypes::blocking)
Definition: clampedPlateFaPatchField.C:95
Foam::Field< scalar >
notImplemented
#define notImplemented(functionName)
Definition: error.H:540
Foam::clampedPlateFaPatchField::gradientBoundaryCoeffs
virtual tmp< Field< Type > > gradientBoundaryCoeffs() const
Definition: clampedPlateFaPatchField.C:154
Foam::faPatchField::evaluate
virtual void evaluate(const Pstream::commsTypes commsType=Pstream::commsTypes::blocking)
Definition: faPatchField.C:188
areaFields.H
dict
dictionary dict
Definition: searchingEngine.H:14
Foam::dictionary
A list of keyword definitions, which are a keyword followed by a number of values (eg,...
Definition: dictionary.H:119
os
OBJstream os(runTime.globalPath()/outputName)
addToRunTimeSelectionTable.H
Macros for easy insertion into run-time selection tables.
Foam
Definition: atmBoundaryLayer.C:26
Foam::clampedPlateFaPatchField::valueInternalCoeffs
virtual tmp< Field< Type > > valueInternalCoeffs(const tmp< scalarField > &) const
Definition: clampedPlateFaPatchField.C:125
Foam::Field::operator=
void operator=(const Field< Type > &)
Foam::UPstream::commsTypes
commsTypes
Definition: UPstream.H:65
uniformDimensionedFields.H
Foam::clampedPlateFaPatchField::gradientInternalCoeffs
virtual tmp< Field< Type > > gradientInternalCoeffs() const
Definition: clampedPlateFaPatchField.C:146
Foam::foamVersion::patch
const std::string patch
Foam::pTraits
A traits class, which is primarily used for primitives.
Definition: pTraits.H:50
Foam::type
fileName::Type type(const fileName &name, const bool followLink=true)
Definition: POSIX.C:717
Foam::UList
A 1D vector of objects of type <T>, where the size of the vector is known and can be used for subscri...
Definition: HashTable.H:99
Foam::clampedPlateFaPatchField
This BC provides a clamped BC. It sets zero fixe value and zeroGradient.
Definition: clampedPlateFaPatchField.H:81
Foam::Ostream
An Ostream is an abstract base class for all output systems (streams, files, token lists,...
Definition: Ostream.H:52
clampedPlateFaPatchField.H
Foam::labelUList
UList< label > labelUList
A UList of labels.
Definition: UList.H:81
Foam::clampedPlateFaPatchField::clampedPlateFaPatchField
clampedPlateFaPatchField(const faPatch &, const DimensionedField< Type, areaMesh > &)
Definition: clampedPlateFaPatchField.C:35
Foam::faPatch
Finite area patch class. Used for 2-D non-Euclidian finite area method.
Definition: faPatch.H:65
Foam::DimensionedField
Field with dimensions and associated with geometry type GeoMesh which is used to size the field and a...
Definition: DimensionedField.H:50
Foam::faPatchField::operator=
virtual void operator=(const UList< Type > &)