SpatialOps
SpatialOps::HyperTanFunction< FieldT, PatchT > Class Template Reference

Hyperbolic tangent Function. More...

#include <FieldFunctions.h>

Inheritance diagram for SpatialOps::HyperTanFunction< FieldT, PatchT >:
Collaboration diagram for SpatialOps::HyperTanFunction< FieldT, PatchT >:

Detailed Description

template<typename FieldT, typename PatchT = FFLocal::NULLPatch>
class SpatialOps::HyperTanFunction< FieldT, PatchT >

Hyperbolic tangent Function.

Author
Naveen Punati
Date
January, 2009 Implements the function

\[ f(x) = \frac{A}{4} \left(1+\tanh\left(\frac{x-L_1}{w}\right)\right) \left(1-\tanh\left(\frac{x-L_2}{w}\right)\right) \]

with
  • $A$ Amplitude of the function
  • $w$ width of the transition
  • $L_1$ and $L_2$ Midpoint of transition from low to high (L1) and high to low (L2).

Definition at line 357 of file FieldFunctions.h.


The documentation for this class was generated from the following file: