All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Pages
ZeroConstant2.H
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) 2020 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 Class
25  Foam::Function2s::ZeroConstant
26 
27 Description
28  Templated function of two variables that returns the corresponding 0 (zero).
29 
30  Usage:
31  \verbatim
32  <name> zero;
33  \endverbatim
34 
35 SourceFiles
36  ZeroConstant.C
37 
38 \*---------------------------------------------------------------------------*/
39 
40 #ifndef ZeroConstant2_H
41 #define ZeroConstant2_H
42 
43 #include "Function2.H"
44 
45 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
46 
47 namespace Foam
48 {
49 namespace Function2s
50 {
51 
52 /*---------------------------------------------------------------------------*\
53  Class ZeroConstant Declaration
54 \*---------------------------------------------------------------------------*/
55 
56 template<class Type>
57 class ZeroConstant
58 :
59  public FieldFunction2<Type, ZeroConstant<Type>>
60 {
61 
62 public:
63 
64  // Runtime type information
65  TypeName("zero");
66 
67 
68  // Constructors
69 
70  //- Construct from name and dictionary
71  ZeroConstant(const word& name, const dictionary& dict);
72 
73 
74  //- Destructor
75  virtual ~ZeroConstant();
76 
77 
78  // Member Functions
79 
80  //- Return Zero
81  virtual inline Type value(const scalar x, const scalar y) const;
82 
83  //- Return Zero field
84  virtual inline tmp<Field<Type>> value
85  (
86  const scalarField& x,
87  const scalarField& y
88  ) const;
89 
90  //- Write in dictionary format
91  virtual void write(Ostream& os) const;
92 
93 
94  // Member Operators
95 
96  //- Disallow default bitwise assignment
97  void operator=(const ZeroConstant<Type>&) = delete;
98 };
99 
100 
101 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
102 
103 } // End namespace Function2s
104 } // End namespace Foam
105 
106 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
107 
108 #include "ZeroConstant2I.H"
109 
110 #ifdef NoRepository
111  #include "ZeroConstant2.C"
112 #endif
113 
114 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
115 
116 #endif
117 
118 // ************************************************************************* //
A list of keyword definitions, which are a keyword followed by any number of values (e...
Definition: dictionary.H:156
const word const dictionary & dict
Definition: Function2.H:84
void operator=(const ZeroConstant< Type > &)=delete
Disallow default bitwise assignment.
const word & name() const
Return the name of the entry.
scalar y
virtual ~ZeroConstant()
Destructor.
Definition: ZeroConstant2.C:44
A class for handling words, derived from string.
Definition: word.H:59
An Ostream is an abstract base class for all output systems (streams, files, token lists...
Definition: Ostream.H:54
virtual void write(Ostream &os) const
Write in dictionary format.
Definition: ZeroConstant2.C:51
A class for managing temporary objects.
Definition: PtrList.H:53
virtual Type value(const scalar x, const scalar y) const
Return Zero.
Templated function of two variables that returns the corresponding 0 (zero).
Definition: ZeroConstant2.H:56
ZeroConstant(const word &name, const dictionary &dict)
Construct from name and dictionary.
Definition: ZeroConstant2.C:32
Namespace for OpenFOAM.