fixedValueFaePatchField.H
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) 2016-2017 Wikki Ltd
9  Copyright (C) 2019 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 Class
28  Foam::fixedValueFaePatchField
29 
30 Description
31 
32 Author
33  Zeljko Tukovic, FMENA
34  Hrvoje Jasak, Wikki Ltd.
35 
36 SourceFiles
37  fixedValueFaePatchField.C
38 
39 \*---------------------------------------------------------------------------*/
40 
41 #ifndef fixedValueFaePatchField_H
42 #define fixedValueFaePatchField_H
43 
44 #include "faePatchField.H"
45 
46 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
47 
48 namespace Foam
49 {
50 
51 /*---------------------------------------------------------------------------*\
52  Class fixedValueFaePatchField Declaration
53 \*---------------------------------------------------------------------------*/
54 
55 template<class Type>
57 :
58  public faePatchField<Type>
59 {
60 
61 public:
62 
63  //- Runtime type information
64  TypeName("fixedValue");
65 
66 
67  // Constructors
68 
69  //- Construct from patch and internal field
71  (
72  const faPatch&,
74  );
75 
76  //- Construct from patch, internal field and dictionary
78  (
79  const faPatch&,
81  const dictionary&
82  );
83 
84  //- Construct by mapping the given fixedValueFaePatchField<Type>
85  // onto a new patch
87  (
89  const faPatch&,
91  const faPatchFieldMapper&
92  );
93 
94  //- Construct as copy
96  (
98  );
99 
100  //- Construct and return a clone
101  virtual tmp<faePatchField<Type>> clone() const
102  {
104  (
106  );
107  }
108 
109  //- Construct as copy setting internal field reference
111  (
114  );
115 
116  //- Construct and return a clone setting internal field reference
118  (
120  ) const
121  {
123  (
124  new fixedValueFaePatchField<Type>(*this, iF)
125  );
126  }
127 
128  //- Destructor
129  virtual ~fixedValueFaePatchField() = default;
130 
131 
132  // Member functions
133 
134  // Access
135 
136  //- Return true if this patch field fixes a value.
137  // Needed to check if a level has to be specified while solving
138  // Poissons equations.
139  virtual bool fixesValue() const
140  {
141  return true;
142  }
143 
144 
145  //- Write
146  virtual void write(Ostream&) const;
147 
148 
149  // Member operators
150 
151  virtual void operator=(const UList<Type>&) {}
152 
153  virtual void operator=(const faePatchField<Type>&) {}
154  virtual void operator+=(const faePatchField<Type>&) {}
155  virtual void operator-=(const faePatchField<Type>&) {}
156  virtual void operator*=(const faePatchField<scalar>&) {}
157  virtual void operator/=(const faePatchField<scalar>&) {}
158 
159  virtual void operator+=(const Field<Type>&) {}
160  virtual void operator-=(const Field<Type>&) {}
161 
162  virtual void operator*=(const Field<scalar>&) {}
163  virtual void operator/=(const Field<scalar>&) {}
164 
165  virtual void operator=(const Type&) {}
166  virtual void operator+=(const Type&) {}
167  virtual void operator-=(const Type&) {}
168  virtual void operator*=(const scalar) {}
169  virtual void operator/=(const scalar) {}
170 };
171 
172 
173 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
174 
175 } // End namespace Foam
176 
177 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
178 
179 #ifdef NoRepository
180  #include "fixedValueFaePatchField.C"
181 #endif
182 
183 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
184 
185 #endif
186 
187 // ************************************************************************* //
Foam::fixedValueFaePatchField::~fixedValueFaePatchField
virtual ~fixedValueFaePatchField()=default
Destructor.
Foam::fixedValueFaePatchField::operator*=
virtual void operator*=(const Field< scalar > &)
Definition: fixedValueFaePatchField.H:161
Foam::faePatchField
faePatchField<Type> abstract base class. This class gives a fat-interface to all derived classes cove...
Definition: edgeFieldsFwd.H:49
Foam::fixedValueFaePatchField::operator-=
virtual void operator-=(const Type &)
Definition: fixedValueFaePatchField.H:166
Foam::fixedValueFaePatchField::fixesValue
virtual bool fixesValue() const
Return true if this patch field fixes a value.
Definition: fixedValueFaePatchField.H:138
Foam::tmp
A class for managing temporary objects.
Definition: PtrList.H:59
Foam::fixedValueFaePatchField::operator/=
virtual void operator/=(const faePatchField< scalar > &)
Definition: fixedValueFaePatchField.H:156
Foam::fixedValueFaePatchField::operator+=
virtual void operator+=(const Field< Type > &)
Definition: fixedValueFaePatchField.H:158
Foam::faPatchFieldMapper
Definition: faPatchFieldMapper.H:44
faePatchField.H
Foam::fixedValueFaePatchField::operator=
virtual void operator=(const faePatchField< Type > &)
Definition: fixedValueFaePatchField.H:152
Foam::fixedValueFaePatchField::operator+=
virtual void operator+=(const Type &)
Definition: fixedValueFaePatchField.H:165
Foam::fixedValueFaePatchField::operator*=
virtual void operator*=(const faePatchField< scalar > &)
Definition: fixedValueFaePatchField.H:155
fixedValueFaePatchField.C
Foam::fixedValueFaePatchField::write
virtual void write(Ostream &) const
Write.
Definition: fixedValueFaePatchField.C:92
Foam::Field
Generic templated field type.
Definition: Field.H:63
Foam::fixedValueFaePatchField::TypeName
TypeName("fixedValue")
Runtime type information.
Foam::dictionary
A list of keyword definitions, which are a keyword followed by a number of values (eg,...
Definition: dictionary.H:121
Foam::fixedValueFaePatchField::operator=
virtual void operator=(const Type &)
Definition: fixedValueFaePatchField.H:164
Foam
Namespace for OpenFOAM.
Definition: atmBoundaryLayer.C:33
Foam::fixedValueFaePatchField::clone
virtual tmp< faePatchField< Type > > clone() const
Construct and return a clone.
Definition: fixedValueFaePatchField.H:100
Foam::fixedValueFaePatchField::operator/=
virtual void operator/=(const scalar)
Definition: fixedValueFaePatchField.H:168
Foam::fixedValueFaePatchField::operator-=
virtual void operator-=(const Field< Type > &)
Definition: fixedValueFaePatchField.H:159
Foam::UList< Type >
Foam::fixedValueFaePatchField::operator*=
virtual void operator*=(const scalar)
Definition: fixedValueFaePatchField.H:167
Foam::fixedValueFaePatchField::operator-=
virtual void operator-=(const faePatchField< Type > &)
Definition: fixedValueFaePatchField.H:154
Foam::fixedValueFaePatchField::operator/=
virtual void operator/=(const Field< scalar > &)
Definition: fixedValueFaePatchField.H:162
Foam::Ostream
An Ostream is an abstract base class for all output systems (streams, files, token lists,...
Definition: Ostream.H:56
Foam::fixedValueFaePatchField::fixedValueFaePatchField
fixedValueFaePatchField(const faPatch &, const DimensionedField< Type, edgeMesh > &)
Construct from patch and internal field.
Definition: fixedValueFaePatchField.C:34
Foam::faPatch
Finite area patch class. Used for 2-D non-Euclidian finite area method.
Definition: faPatch.H:65
Foam::fixedValueFaePatchField
Author Zeljko Tukovic, FMENA Hrvoje Jasak, Wikki Ltd.
Definition: fixedValueFaePatchField.H:55
Foam::fixedValueFaePatchField::operator+=
virtual void operator+=(const faePatchField< Type > &)
Definition: fixedValueFaePatchField.H:153
Foam::fixedValueFaePatchField::operator=
virtual void operator=(const UList< Type > &)
Definition: fixedValueFaePatchField.H:150
Foam::DimensionedField
Field with dimensions and associated with geometry type GeoMesh which is used to size the field and a...
Definition: DimensionedField.H:54