A spatial distribution with a sine wave function as a separatrix. More...
#include <SineSepar.hpp>
Inheritance diagram for SineSepar:
Collaboration diagram for SineSepar:
Public Member Functions | |
| SineSepar (double Amp, double f, double off, double above, double under) | |
| Class constructor. More... | |
| double | operator() (const Vector2D &r) const |
| Evaluates the function. More... | |
Detailed Description
A spatial distribution with a sine wave function as a separatrix.
Definition at line 13 of file SineSepar.hpp.
Constructor & Destructor Documentation
◆ SineSepar()
| SineSepar::SineSepar | ( | double | Amp, |
| double | f, | ||
| double | off, | ||
| double | above, | ||
| double | under | ||
| ) |
Class constructor.
- Parameters
-
Amp Amplitude f Frequency off Offset above Value above the sine under Value under the sine
Definition at line 3 of file SineSepar.cpp.
Member Function Documentation
◆ operator()()
|
virtual |
Evaluates the function.
- Parameters
-
point Position
- Returns
- The value of the function at the point
Implements SpatialDistribution.
Definition at line 10 of file SineSepar.cpp.
The documentation for this class was generated from the following files:
- source/newtonian/two_dimensional/spatial_distributions/SineSepar.hpp
- source/newtonian/two_dimensional/spatial_distributions/SineSepar.cpp
