File size: 5,161 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 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 | /*---------------------------------------------------------------------------*\
========= |
\\ / F ield | OpenFOAM: The Open Source CFD Toolbox
\\ / O peration | Website: https://openfoam.org
\\ / A nd | Copyright (C) 2016-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::Square
Description
Templated square-wave function with support for an offset level.
\f[
a square(f (x - x_0) ) + l
\f]
where
\f$square(x)\f$ is the square-wave function in range \f$[-1, 1]\f$ with a
mark/space ratio of \f$r\f$
\vartable
Symbol | Description | Data type | Default
a | Amplitude | Function1<Type> |
f | Frequency | scalar |
x_0 | Phase | scalar | 0
l | Offset level | Function1<Type> |
D | Duty cycle | scalar | 0.5
r | Mark/space ratio | scalar | 1
\endvartable
Example for a scalar:
\verbatim
<name> square;
<name>Coeffs
{
amplitude 2e-7;
frequency 10;
start 0;
level 2e-6;
dutyCycle 0.5;
}
\endverbatim
Example for a vector:
\verbatim
<name> square;
<name>Coeffs
{
amplitude (1 0.1 0);
frequency 10;
start 0;
level (10 1 0);
markSpace 1;
}
\endverbatim
SourceFiles
Square.C
\*---------------------------------------------------------------------------*/
#ifndef Square_H
#define Square_H
#include "Function1.H"
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
namespace Foam
{
namespace Function1s
{
/*---------------------------------------------------------------------------*\
Class Square Declaration
\*---------------------------------------------------------------------------*/
template<class Type>
class Square
:
public FieldFunction1<Type, Square<Type>>
{
// Private Data
//- Scalar amplitude of the square function
const autoPtr<Function1<Type>> amplitude_;
//- Frequency of the square function
const scalar frequency_;
//- Argument offset
const scalar start_;
//- Level to which the square function is added
const autoPtr<Function1<Type>> level_;
//- The fraction of one period in which the function value is at the
// higher of the two possible values
const scalar dutyCycle_;
//- Is this function integrable?
const bool integrable_;
// Private Member Functions
//- Read the duty cycle
scalar readDutyCycle(const dictionary& dict) const;
public:
// Runtime type information
TypeName("square");
// Constructors
//- Construct from name and dictionary
Square
(
const word& name,
const unitSets& units,
const dictionary& dict
);
//- Copy constructor
Square(const Square<Type>& se);
//- Destructor
virtual ~Square();
// Member Functions
//- Return the value at a scalar coordinate
virtual inline Type value(const scalar x) const;
//- Return the derivative at a scalar coordinate
virtual inline Type derivative(const scalar x) const;
//- Return the integral between two scalar coordinates
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 Square<Type>&) = delete;
};
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
} // End namespace Function1s
} // End namespace Foam
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
#include "SquareI.H"
#ifdef NoRepository
#include "Square.C"
#endif
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
#endif
// ************************************************************************* //
|