introvoyz042's picture
Migrated from GitHub
5a600cf verified
Raw History Blame Contribute Delete
3.32 kB
/*---------------------------------------------------------------------------*\
========= |
\\ / F ield | OpenFOAM: The Open Source CFD Toolbox
\\ / O peration | Website: https://openfoam.org
\\ / A nd | Copyright (C) 2017-2026 OpenFOAM Foundation
\\/ M anipulation |
-------------------------------------------------------------------------------
License
This file is part of OpenFOAM.
OpenFOAM is free software: you can redistribute it and/or modify it
under the terms of the GNU General Public License as published by
the Free Software Foundation, either version 3 of the License, or
(at your option) any later version.
OpenFOAM is distributed in the hope that it will be useful, but WITHOUT
ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
for more details.
You should have received a copy of the GNU General Public License
along with OpenFOAM. If not, see <http://www.gnu.org/licenses/>.
Class
Foam::Function1s::ZeroConstant
Description
Templated function that returns the corresponding 0 (zero).
Usage
\verbatim
<name> zero;
\endverbatim
SourceFiles
ZeroConstant.C
\*---------------------------------------------------------------------------*/
#ifndef ZeroConstant_H
#define ZeroConstant_H
#include "Function1.H"
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
namespace Foam
{
namespace Function1s
{
/*---------------------------------------------------------------------------*\
Class ZeroConstant Declaration
\*---------------------------------------------------------------------------*/
template<class Type>
class ZeroConstant
:
public FieldFunction1<Type, ZeroConstant<Type>>
{
public:
// Runtime type information
TypeName("zero");
// Constructors
//- Construct from name
ZeroConstant(const word& name);
//- Construct from name and dictionary
ZeroConstant
(
const word& name,
const unitSets& units,
const dictionary& dict
);
//- Destructor
virtual ~ZeroConstant();
// Member Functions
//- Return zero
virtual inline Type value(const scalar x) const;
//- Return zero
virtual inline Type derivative(const scalar x) const;
//- Return zero
virtual inline Type integral(const scalar x1, const scalar x2) const;
//- Write in dictionary format
virtual void write(Ostream& os, const unitSets& units) const;
// Member Operators
//- Disallow default bitwise assignment
void operator=(const ZeroConstant<Type>&) = delete;
};
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
} // End namespace Function1s
} // End namespace Foam
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
#include "ZeroConstantI.H"
#ifdef NoRepository
#include "ZeroConstant.C"
#endif
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
#endif
// ************************************************************************* //