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-------------------------------------------------------------------------------
11License
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
27Class
28 Foam::fixedValueFaePatchField
29
30Description
31
32Author
33 Zeljko Tukovic, FMENA
34 Hrvoje Jasak, Wikki Ltd.
35
36SourceFiles
37 fixedValueFaePatchField.C
38
39\*---------------------------------------------------------------------------*/
40
41#ifndef fixedValueFaePatchField_H
42#define fixedValueFaePatchField_H
43
44#include "faePatchField.H"
45
46// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
47
48namespace Foam
49{
50
51/*---------------------------------------------------------------------------*\
52 Class fixedValueFaePatchField Declaration
53\*---------------------------------------------------------------------------*/
54
55template<class Type>
57:
58 public faePatchField<Type>
59{
60
61public:
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&,
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
151 virtual void operator=(const UList<Type>&) {}
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>&) {}
159 virtual void operator+=(const Field<Type>&) {}
160 virtual void operator-=(const Field<Type>&) {}
162 virtual void operator*=(const Field<scalar>&) {}
163 virtual void operator/=(const Field<scalar>&) {}
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
181#endif
182
183// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
184
185#endif
186
187// ************************************************************************* //
Field with dimensions and associated with geometry type GeoMesh which is used to size the field and a...
Generic templated field type.
Definition: Field.H:82
An Ostream is an abstract base class for all output systems (streams, files, token lists,...
Definition: Ostream.H:62
A 1D vector of objects of type <T>, where the size of the vector is known and can be used for subscri...
Definition: UList.H:94
A list of keyword definitions, which are a keyword followed by a number of values (eg,...
Definition: dictionary.H:126
A FieldMapper for finite-area patch fields.
Finite area patch class. Used for 2-D non-Euclidian finite area method.
Definition: faPatch.H:78
faePatchField<Type> abstract base class. This class gives a fat-interface to all derived classes cove...
Definition: faePatchField.H:83
Author Zeljko Tukovic, FMENA Hrvoje Jasak, Wikki Ltd.
virtual void operator/=(const Field< scalar > &)
virtual bool fixesValue() const
Return true if this patch field fixes a value.
virtual void operator-=(const faePatchField< Type > &)
virtual ~fixedValueFaePatchField()=default
Destructor.
virtual void operator+=(const Field< Type > &)
virtual void operator=(const Type &)
virtual void operator*=(const Field< scalar > &)
virtual tmp< faePatchField< Type > > clone(const DimensionedField< Type, edgeMesh > &iF) const
Construct and return a clone setting internal field reference.
TypeName("fixedValue")
Runtime type information.
virtual void operator*=(const faePatchField< scalar > &)
virtual void operator/=(const scalar)
virtual void operator=(const UList< Type > &)
virtual tmp< faePatchField< Type > > clone() const
Construct and return a clone.
virtual void operator=(const faePatchField< Type > &)
virtual void operator-=(const Type &)
virtual void operator+=(const faePatchField< Type > &)
virtual void operator/=(const faePatchField< scalar > &)
virtual void operator*=(const scalar)
virtual void operator-=(const Field< Type > &)
virtual void operator+=(const Type &)
A class for managing temporary objects.
Definition: tmp.H:65
Namespace for OpenFOAM.
runTime write()
#define TypeName(TypeNameString)
Declare a ClassName() with extra virtual type info.
Definition: typeInfo.H:73