coupledFvPatchField.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 -------------------------------------------------------------------------------
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 
28 #include "coupledFvPatchField.H"
29 
30 // * * * * * * * * * * * * * * * Member Functions * * * * * * * * * * * * * //
31 
32 template<class Type>
34 (
35  const fvPatch& p,
37 )
38 :
39  LduInterfaceField<Type>(refCast<const lduInterface>(p)),
41 {}
42 
43 
44 template<class Type>
46 (
47  const fvPatch& p,
49  const Field<Type>& f
50 )
51 :
52  LduInterfaceField<Type>(refCast<const lduInterface>(p)),
53  fvPatchField<Type>(p, iF, f)
54 {}
55 
56 
57 template<class Type>
59 (
60  const coupledFvPatchField<Type>& ptf,
61  const fvPatch& p,
63  const fvPatchFieldMapper& mapper
64 )
65 :
66  LduInterfaceField<Type>(refCast<const lduInterface>(p)),
67  fvPatchField<Type>(ptf, p, iF, mapper)
68 {}
69 
70 
71 template<class Type>
73 (
74  const fvPatch& p,
76  const dictionary& dict,
77  const bool valueRequired
78 )
79 :
80  LduInterfaceField<Type>(refCast<const lduInterface>(p, dict)),
81  fvPatchField<Type>(p, iF, dict, valueRequired)
82 {}
83 
84 
85 template<class Type>
87 (
88  const coupledFvPatchField<Type>& ptf
89 )
90 :
91  LduInterfaceField<Type>(refCast<const lduInterface>(ptf.patch())),
93 {}
94 
95 
96 template<class Type>
98 (
99  const coupledFvPatchField<Type>& ptf,
101 )
102 :
103  LduInterfaceField<Type>(refCast<const lduInterface>(ptf.patch())),
104  fvPatchField<Type>(ptf, iF)
105 {}
106 
107 
108 // * * * * * * * * * * * * * * * Member Functions * * * * * * * * * * * * * //
109 
110 template<class Type>
112 (
113  const scalarField& deltaCoeffs
114 ) const
115 {
116  return
117  deltaCoeffs
118  *(this->patchNeighbourField() - this->patchInternalField());
119 }
120 
121 
122 template<class Type>
124 {
125  if (!this->updated())
126  {
127  this->updateCoeffs();
128  }
129 }
130 
131 
132 template<class Type>
134 {
135  if (!this->updated())
136  {
137  this->updateCoeffs();
138  }
139 
141  (
142  this->patch().weights()*this->patchInternalField()
143  + (1.0 - this->patch().weights())*this->patchNeighbourField()
144  );
145 
147 }
148 
149 
150 template<class Type>
153 (
154  const tmp<scalarField>& w
155 ) const
156 {
157  return Type(pTraits<Type>::one)*w;
158 }
159 
160 
161 template<class Type>
164 (
165  const tmp<scalarField>& w
166 ) const
167 {
168  return Type(pTraits<Type>::one)*(1.0 - w);
169 }
170 
171 
172 template<class Type>
175 (
176  const scalarField& deltaCoeffs
177 ) const
178 {
179  return -Type(pTraits<Type>::one)*deltaCoeffs;
180 }
181 
182 
183 template<class Type>
186 {
188  return -Type(pTraits<Type>::one)*this->patch().deltaCoeffs();
189 }
190 
191 
192 template<class Type>
195 (
196  const scalarField& deltaCoeffs
197 ) const
198 {
199  return -this->gradientInternalCoeffs(deltaCoeffs);
200 }
201 
202 
203 template<class Type>
206 {
208  return -this->gradientInternalCoeffs();
209 }
210 
211 
212 template<class Type>
214 {
216  this->writeEntry("value", os);
217 }
218 
219 
220 // ************************************************************************* //
Foam::fvPatchField
Abstract base class with a fat-interface to all derived classes covering all possible ways in which t...
Definition: volSurfaceMapping.H:51
p
volScalarField & p
Definition: createFieldRefs.H:8
Foam::coupledFvPatchField::coupledFvPatchField
coupledFvPatchField(const fvPatch &, const DimensionedField< Type, volMesh > &)
Construct from patch and internal field.
Definition: coupledFvPatchField.C:34
Foam::tmp
A class for managing temporary objects.
Definition: PtrList.H:61
Foam::coupledFvPatchField::initEvaluate
virtual void initEvaluate(const Pstream::commsTypes commsType)
Initialise the evaluation of the patch field.
Definition: coupledFvPatchField.C:123
Foam::coupledFvPatchField::gradientBoundaryCoeffs
virtual tmp< Field< Type > > gradientBoundaryCoeffs() const
Return the matrix source coefficients corresponding to the.
Definition: coupledFvPatchField.C:205
NotImplemented
#define NotImplemented
Issue a FatalErrorIn for a function not currently implemented.
Definition: error.H:517
Foam::Field
Generic templated field type.
Definition: Field.H:63
Foam::coupledFvPatchField::gradientInternalCoeffs
virtual tmp< Field< Type > > gradientInternalCoeffs() const
Return the matrix diagonal coefficients corresponding to the.
Definition: coupledFvPatchField.C:185
Foam::fvPatch
A finiteVolume patch using a polyPatch and a fvBoundaryMesh.
Definition: fvPatch.H:65
Foam::coupledFvPatchField::evaluate
virtual void evaluate(const Pstream::commsTypes commsType)
Evaluate the patch field.
Definition: coupledFvPatchField.C:133
Foam::LduInterfaceField
An abstract base class for implicitly-coupled interface fields e.g. processor and cyclic patch fields...
Definition: LduInterfaceField.H:58
Foam::coupledFvPatchField::valueBoundaryCoeffs
virtual tmp< Field< Type > > valueBoundaryCoeffs(const tmp< scalarField > &) const
Return the matrix source coefficients corresponding to the.
Definition: coupledFvPatchField.C:164
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:123
os
OBJstream os(runTime.globalPath()/outputName)
Foam::UPstream::commsTypes
commsTypes
Types of communications.
Definition: UPstream.H:69
f
labelList f(nPoints)
Foam::foamVersion::patch
const std::string patch
OpenFOAM patch number as a std::string.
Foam::coupledFvPatchField
Abstract base class for coupled patches.
Definition: coupledFvPatchField.H:57
Foam::pTraits
A traits class, which is primarily used for primitives.
Definition: pTraits.H:56
Foam::vtk::write
void write(vtk::formatter &fmt, const Type &val, const label n=1)
Component-wise write of a value (N times)
Definition: foamVtkOutputTemplates.C:36
Foam::fvPatchFieldMapper
Foam::fvPatchFieldMapper.
Definition: fvPatchFieldMapper.H:47
Foam::fvPatchField::patch
const fvPatch & patch() const
Return patch.
Definition: fvPatchField.H:357
Foam::Ostream
An Ostream is an abstract base class for all output systems (streams, files, token lists,...
Definition: Ostream.H:56
coupledFvPatchField.H
Foam::coupledFvPatchField::snGrad
virtual tmp< Field< Type > > snGrad() const
Return patch-normal gradient.
Definition: coupledFvPatchField.H:151
Foam::coupledFvPatchField::valueInternalCoeffs
virtual tmp< Field< Type > > valueInternalCoeffs(const tmp< scalarField > &) const
Return the matrix diagonal coefficients corresponding to the.
Definition: coupledFvPatchField.C:153
Foam::coupledFvPatchField::write
virtual void write(Ostream &) const
Write.
Definition: coupledFvPatchField.C:213
Foam::DimensionedField
Field with dimensions and associated with geometry type GeoMesh which is used to size the field and a...
Definition: DimensionedField.H:54
Foam::stringOps::evaluate
string evaluate(label fieldWidth, const std::string &s, size_t pos=0, size_t len=std::string::npos)
String evaluation with specified (positive, non-zero) field width.
Definition: stringOpsEvaluate.C:37