OneConstant.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) 2017 OpenFOAM Foundation
9  Copyright (C) 2020 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::Function1Types::OneConstant
29 
30 Description
31  Templated function that returns the corresponding 1 (one).
32 
33  Usage:
34  \verbatim
35  <entryName> one;
36  \endverbatim
37 
38 SourceFiles
39  OneConstant.C
40 
41 \*---------------------------------------------------------------------------*/
42 
43 #ifndef OneConstant_H
44 #define OneConstant_H
45 
46 #include "Function1.H"
47 
48 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
49 
50 namespace Foam
51 {
52 namespace Function1Types
53 {
54 
55 /*---------------------------------------------------------------------------*\
56  Class OneConstant Declaration
57 \*---------------------------------------------------------------------------*/
58 
59 template<class Type>
60 class OneConstant
61 :
62  public Function1<Type>
63 {
64 public:
65 
66  //- Runtime type information
67  TypeName("one");
68 
69 
70  // Generated Methods
71 
72  //- No copy assignment
73  void operator=(const OneConstant<Type>&) = delete;
74 
75 
76  // Constructors
77 
78  //- Construct from entry name
79  explicit OneConstant(const word& entryName);
80 
81  //- Construct from entry name and dictionary
82  OneConstant(const word& entryName, const dictionary& dict);
83 
84  //- Construct and return a clone
85  virtual tmp<Function1<Type>> clone() const
86  {
87  return tmp<Function1<Type>>(new OneConstant<Type>(*this));
88  }
89 
90 
91  //- Destructor
92  virtual ~OneConstant() = default;
93 
94 
95  // Member Functions
96 
97  //- Return constant value
98  virtual inline Type value(const scalar) const;
99 
100  //- Integrate between two values
101  virtual inline Type integrate(const scalar x1, const scalar x2) const;
102 
103  //- Return value as a function of (scalar) independent variable
104  virtual tmp<Field<Type>> value(const scalarField& x) const;
105 
106  //- Integrate between two (scalar) values
107  virtual tmp<Field<Type>> integrate
108  (
109  const scalarField& x1,
110  const scalarField& x2
111  ) const;
112 
113  //- Write in dictionary format
114  virtual void writeData(Ostream& os) const;
115 };
116 
117 
118 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
119 
120 } // End namespace Function1Types
121 } // End namespace Foam
122 
123 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
124 
125 #include "OneConstantI.H"
126 
127 #ifdef NoRepository
128  #include "OneConstant.C"
129 #endif
130 
131 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
132 
133 #endif
134 
135 // ************************************************************************* //
Foam::Function1Types::OneConstant::operator=
void operator=(const OneConstant< Type > &)=delete
No copy assignment.
Foam::word
A class for handling words, derived from Foam::string.
Definition: word.H:62
Foam::Function1Types::OneConstant::integrate
virtual Type integrate(const scalar x1, const scalar x2) const
Integrate between two values.
Definition: OneConstantI.H:41
OneConstant.C
Foam::tmp
A class for managing temporary objects.
Definition: PtrList.H:61
Foam::Function1Types::OneConstant::~OneConstant
virtual ~OneConstant()=default
Destructor.
Foam::Function1::entryName
const word & entryName
Definition: Function1.H:133
Function1.H
Foam::Function1::dict
const word const dictionary & dict
Definition: Function1.H:135
OneConstantI.H
Foam::Function1
Top level data entry class for use in dictionaries. Provides a mechanism to specify a variable as a c...
Definition: Function1.H:86
Foam::Function1Types::OneConstant::value
virtual Type value(const scalar) const
Return constant value.
Definition: OneConstantI.H:33
Foam::Field< scalar >
Foam::Function1Types::OneConstant
Templated function that returns the corresponding 1 (one).
Definition: OneConstant.H:59
Foam::dictionary
A list of keyword definitions, which are a keyword followed by a number of values (eg,...
Definition: dictionary.H:121
Foam::Function1Types::OneConstant::clone
virtual tmp< Function1< Type > > clone() const
Construct and return a clone.
Definition: OneConstant.H:84
Foam
Namespace for OpenFOAM.
Definition: atmBoundaryLayer.C:33
Foam::Function1Types::OneConstant::OneConstant
OneConstant(const word &entryName)
Construct from entry name.
Definition: OneConstant.C:33
Foam::Function1Types::OneConstant::TypeName
TypeName("one")
Runtime type information.
x
x
Definition: LISASMDCalcMethod2.H:52
Foam::Function1Types::OneConstant::writeData
virtual void writeData(Ostream &os) const
Write in dictionary format.
Definition: OneConstant.C:74
Foam::Ostream
An Ostream is an abstract base class for all output systems (streams, files, token lists,...
Definition: Ostream.H:56