mirror of
https://develop.openfoam.com/Development/openfoam.git
synced 2025-11-28 03:28:01 +00:00
60281da466
with optional specification of the mark/space ratio
Templated square-wave function with support for an offset level.
\f[
a square(f (t - t_0)) s + l
\f]
where
\f$ square(t) \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<scalar> |
f | Frequency [1/s] | Function1<scalar> |
s | Type scale factor | Function1<Type> |
l | Type offset level | Function1<Type> |
t_0 | Start time [s] | scalar | 0
r | mark/space ratio | scalar | 1
t | Time [s] | scalar
\endvartable
Example for a scalar:
\verbatim
<entryName> square;
<entryName>Coeffs
{
frequency 10;
amplitude 0.1;
scale 2e-6;
level 2e-6;
}
\endverbatim
105 lines
3.2 KiB
C
105 lines
3.2 KiB
C
/*---------------------------------------------------------------------------*\
|
|
========= |
|
|
\\ / F ield | OpenFOAM: The Open Source CFD Toolbox
|
|
\\ / O peration |
|
|
\\ / A nd | Copyright (C) 2016 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/>.
|
|
|
|
\*---------------------------------------------------------------------------*/
|
|
|
|
#include "Sine.H"
|
|
#include "mathematicalConstants.H"
|
|
|
|
// * * * * * * * * * * * * * * * * Constructors * * * * * * * * * * * * * * //
|
|
|
|
template<class Type>
|
|
void Foam::Function1Types::Sine<Type>::read(const dictionary& coeffs)
|
|
{
|
|
t0_ = coeffs.lookupOrDefault<scalar>("t0", 0);
|
|
amplitude_ = Function1<scalar>::New("amplitude", coeffs);
|
|
frequency_ = Function1<scalar>::New("frequency", coeffs);
|
|
scale_ = Function1<Type>::New("scale", coeffs);
|
|
level_ = Function1<Type>::New("level", coeffs);
|
|
}
|
|
|
|
|
|
template<class Type>
|
|
Foam::Function1Types::Sine<Type>::Sine
|
|
(
|
|
const word& entryName,
|
|
const dictionary& dict,
|
|
const word& ext
|
|
)
|
|
:
|
|
Function1<Type>(entryName)
|
|
{
|
|
read(dict.subDict(entryName + ext));
|
|
}
|
|
|
|
|
|
template<class Type>
|
|
Foam::Function1Types::Sine<Type>::Sine(const Sine<Type>& se)
|
|
:
|
|
Function1<Type>(se),
|
|
t0_(se.t0_),
|
|
amplitude_(se.amplitude_, false),
|
|
frequency_(se.frequency_, false),
|
|
scale_(se.scale_, false),
|
|
level_(se.level_, false)
|
|
{}
|
|
|
|
|
|
// * * * * * * * * * * * * * * * * Destructor * * * * * * * * * * * * * * * //
|
|
|
|
template<class Type>
|
|
Foam::Function1Types::Sine<Type>::~Sine()
|
|
{}
|
|
|
|
|
|
// * * * * * * * * * * * * * * * Member Functions * * * * * * * * * * * * * //
|
|
|
|
template<class Type>
|
|
Type Foam::Function1Types::Sine<Type>::value(const scalar t) const
|
|
{
|
|
return
|
|
amplitude_->value(t)
|
|
*sin(constant::mathematical::twoPi*frequency_->value(t)*(t - t0_))
|
|
*scale_->value(t)
|
|
+ level_->value(t);
|
|
}
|
|
|
|
|
|
template<class Type>
|
|
void Foam::Function1Types::Sine<Type>::writeData(Ostream& os) const
|
|
{
|
|
Function1<Type>::writeData(os);
|
|
os << token::END_STATEMENT << nl;
|
|
os << indent << word(this->name() + "Coeffs") << nl;
|
|
os << indent << token::BEGIN_BLOCK << incrIndent << nl;
|
|
os.writeKeyword("t0") << t0_ << token::END_STATEMENT << nl;
|
|
amplitude_->writeData(os);
|
|
frequency_->writeData(os);
|
|
scale_->writeData(os);
|
|
level_->writeData(os);
|
|
os << decrIndent << indent << token::END_BLOCK << endl;
|
|
}
|
|
|
|
|
|
// ************************************************************************* //
|