GRINS::GaussianProfile Class Reference

Gaussian profile. More...

#include <gaussian_profile.h>

Inheritance diagram for GRINS::GaussianProfile:

Collaboration diagram for GRINS::GaussianProfile:

Public Member Functions
	GaussianProfile (const double a, const double mu, const double sigma, const double b)
virtual	~GaussianProfile ()

Protected Member Functions
double	eval (const double r)

Protected Attributes
double	_a
	Coefficients defining parabola. More...
double	_mu
double	_variance
double	_b

Private Member Functions
	GaussianProfile ()

Detailed Description

Gaussian profile.

Generic Gaussian profile. Mainly used for defining inflow boundary conditions. Function takes the form: where is a shift so that is continuous. In particular, if . is computed in the derived classes, depending on the plane the function is defined in.

Definition at line 45 of file gaussian_profile.h.

Constructor & Destructor Documentation

GRINS::GaussianProfile::GaussianProfile	(	const double	a,
		const double	mu,
		const double	sigma,
		const double	b
	)

Definition at line 35 of file gaussian_profile.C.

    : libMesh::FunctionBase<libMesh::Number>(),
      _a(a),
      _mu(mu),
      _variance(sigma*sigma),
      _b(b)
  {
    return;
  }

GRINS::GaussianProfile::~GaussianProfile ( )

virtual

Definition at line 46 of file gaussian_profile.C.

  {
    return;
  }

GRINS::GaussianProfile::GaussianProfile ( )

private

Member Function Documentation

double GRINS::GaussianProfile::eval ( const double  r )

inlineprotected

Definition at line 56 of file gaussian_profile.h.

References _a, _b, _mu, and _variance.

    {
      const double r_m_mu = r - _mu;
      return _a*std::exp( -r_m_mu*r_m_mu/(2.0*_variance) ) - _b;
    };

Member Data Documentation

double GRINS::GaussianProfile::_a

protected

Coefficients defining parabola.

Definition at line 60 of file gaussian_profile.h.

Referenced by eval().

double GRINS::GaussianProfile::_b

protected

Definition at line 60 of file gaussian_profile.h.

Referenced by eval().

double GRINS::GaussianProfile::_mu

protected

Definition at line 60 of file gaussian_profile.h.

Referenced by eval().

double GRINS::GaussianProfile::_variance

protected

Definition at line 60 of file gaussian_profile.h.

Referenced by eval().

---

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

• src/boundary_conditions/include/grins/gaussian_profile.h
• src/boundary_conditions/src/gaussian_profile.C