File size: 4,054 Bytes
5a600cf | 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 | /*---------------------------------------------------------------------------*\
========= |
\\ / F ield | OpenFOAM: The Open Source CFD Toolbox
\\ / O peration | Website: https://openfoam.org
\\ / A nd | Copyright (C) 2021-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::squarePulse
Description
Square pulse function. Takes a value of 0 before \c start, then rises
instantaneously to 1, remains at 1 for \c duration, then drops
instantaneously back to 0.
Usage
\verbatim
<name> squarePulse;
<name>Coeffs
{
start 10;
duration 20;
}
\endverbatim
or
\verbatim
<name>
{
type squarePulse;
start 10;
duration 20;
}
\endverbatim
Where:
\table
Property | Description | Required | Default value
start | Start time | no | 0
duration | Duration | yes |
\endtable
See also
Foam::Function1
SourceFiles
squarePulse.C
\*---------------------------------------------------------------------------*/
#ifndef squarePulse_H
#define squarePulse_H
#include "Function1.H"
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
namespace Foam
{
namespace Function1s
{
/*---------------------------------------------------------------------------*\
Class squarePulse Declaration
\*---------------------------------------------------------------------------*/
class squarePulse
:
public FieldFunction1<scalar, squarePulse>
{
// Private data
//- Start-time of the ramp function
const scalar start_;
//- Duration of the ramp function
const scalar duration_;
public:
// Runtime type information
TypeName("squarePulse");
// Constructors
//- Construct from name and dictionary
squarePulse
(
const word& name,
const unitSets& units,
const dictionary& dict
);
//- Destructor
virtual ~squarePulse();
// Member Functions
//- Return the value at a scalar coordinate
virtual inline scalar value(const scalar x) const;
//- Return the derivative at a scalar coordinate
virtual inline scalar derivative(const scalar x) const;
//- Return the integral between two scalar coordinates
virtual inline scalar 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 squarePulse&) = delete;
};
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
} // End namespace Function1s
} // End namespace Foam
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
#ifdef NoRepository
#include "squarePulseI.H"
#endif
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
#endif
// ************************************************************************* //
|