fixedValueFvPatchField.C
Go to the documentation of this file.
1 /*---------------------------------------------------------------------------*\
2  ========= |
3  \\ / F ield | OpenFOAM: The Open Source CFD Toolbox
4  \\ / O peration | Website: https://openfoam.org
5  \\ / A nd | Copyright (C) 2011-2018 OpenFOAM Foundation
6  \\/ M anipulation |
7 -------------------------------------------------------------------------------
8 License
9  This file is part of OpenFOAM.
10 
11  OpenFOAM is free software: you can redistribute it and/or modify it
12  under the terms of the GNU General Public License as published by
13  the Free Software Foundation, either version 3 of the License, or
14  (at your option) any later version.
15 
16  OpenFOAM is distributed in the hope that it will be useful, but WITHOUT
17  ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
18  FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
19  for more details.
20 
21  You should have received a copy of the GNU General Public License
22  along with OpenFOAM. If not, see <http://www.gnu.org/licenses/>.
23 
24 \*---------------------------------------------------------------------------*/
25 
26 #include "fixedValueFvPatchField.H"
27 
28 // * * * * * * * * * * * * * * * Member Functions * * * * * * * * * * * * * //
29 
30 template<class Type>
32 (
33  const fvPatch& p,
35 )
36 :
38 {}
39 
40 
41 template<class Type>
43 (
44  const fvPatch& p,
46  const Type& value
47 )
48 :
49  fvPatchField<Type>(p, iF, value)
50 {}
51 
52 
53 template<class Type>
55 (
56  const fvPatch& p,
58  const dictionary& dict,
59  const bool valueRequired
60 )
61 :
62  fvPatchField<Type>(p, iF, dict, valueRequired)
63 {}
64 
65 
66 template<class Type>
68 (
70  const fvPatch& p,
72  const fvPatchFieldMapper& mapper
73 )
74 :
75  fvPatchField<Type>(ptf, p, iF, mapper)
76 {
77  if (notNull(iF) && mapper.hasUnmapped())
78  {
80  << "On field " << iF.name() << " patch " << p.name()
81  << " patchField " << this->type()
82  << " : mapper does not map all values." << nl
83  << " To avoid this warning fully specify the mapping in derived"
84  << " patch fields." << endl;
85  }
86 }
87 
88 
89 template<class Type>
91 (
93 )
94 :
96 {}
97 
98 
99 template<class Type>
101 (
102  const fixedValueFvPatchField<Type>& ptf,
104 )
105 :
106  fvPatchField<Type>(ptf, iF)
107 {}
108 
109 
110 // * * * * * * * * * * * * * * * Member Functions * * * * * * * * * * * * * //
111 
112 template<class Type>
115 (
116  const tmp<scalarField>&
117 ) const
118 {
119  return tmp<Field<Type>>
120  (
121  new Field<Type>(this->size(), Zero)
122  );
123 }
124 
125 
126 template<class Type>
129 (
130  const tmp<scalarField>&
131 ) const
132 {
133  return *this;
134 }
135 
136 
137 template<class Type>
140 {
141  return -pTraits<Type>::one*this->patch().deltaCoeffs();
142 }
143 
144 
145 template<class Type>
148 {
149  return this->patch().deltaCoeffs()*(*this);
150 }
151 
152 
153 template<class Type>
155 {
157  this->writeEntry("value", os);
158 }
159 
160 
161 // ************************************************************************* //
This boundary condition supplies a fixed value constraint, and is the base class for a number of othe...
dictionary dict
virtual tmp< Field< Type > > gradientBoundaryCoeffs() const
Return the matrix source coefficients corresponding to the.
type
Types of root.
Definition: Roots.H:52
virtual void write(Ostream &) const
Write.
A list of keyword definitions, which are a keyword followed by any number of values (e...
Definition: dictionary.H:137
Ostream & endl(Ostream &os)
Add newline and flush stream.
Definition: Ostream.H:256
A finiteVolume patch using a polyPatch and a fvBoundaryMesh.
Definition: fvPatch.H:61
Traits class for primitives.
Definition: pTraits.H:50
Abstract base class with a fat-interface to all derived classes covering all possible ways in which t...
Definition: fvPatchField.H:66
virtual tmp< Field< Type > > valueBoundaryCoeffs(const tmp< scalarField > &) const
Return the matrix source coefficients corresponding to the.
void write(Ostream &, const label, const dictionary &)
Write with dictionary lookup.
Pre-declare SubField and related Field type.
Definition: Field.H:57
Foam::fvPatchFieldMapper.
virtual tmp< Field< Type > > valueInternalCoeffs(const tmp< scalarField > &) const
Return the matrix diagonal coefficients corresponding to the.
static const zero Zero
Definition: zero.H:97
virtual tmp< Field< Type > > gradientInternalCoeffs() const
Return the matrix diagonal coefficients corresponding to the.
virtual bool hasUnmapped() const =0
Are there unmapped values? I.e. do all size() elements get.
fixedValueFvPatchField(const fvPatch &, const DimensionedField< Type, volMesh > &)
Construct from patch and internal field.
An Ostream is an abstract base class for all output systems (streams, files, token lists...
Definition: Ostream.H:53
static const char nl
Definition: Ostream.H:265
bool notNull(const T &t)
Return true if t is not a reference to the nullObject of type T.
Definition: nullObjectI.H:46
#define WarningInFunction
Report a warning using Foam::Warning.
Field with dimensions and associated with geometry type GeoMesh which is used to size the field and a...
volScalarField & p
A class for managing temporary objects.
Definition: PtrList.H:53