SmoothTransition Class Reference

Base class for smooth transitions between two functions of one variable. More...

#include <SmoothTransition.h>

Inheritance diagram for SmoothTransition:

Public Member Functions
	SmoothTransition (const Real &x_center, const Real &transition_width)
	Constructor.
virtual Real	value (const Real &x, const Real &f1, const Real &f2) const =0
	Computes the transition value.
const Real &	leftEnd () const
	Returns the coordinate of the left end of the transition.
const Real &	rightEnd () const
	Returns the coordinate of the right end of the transition.

Protected Attributes
const Real	_x_center
	Center point of transition.
const Real	_transition_width
	Width of transition.
const Real	_x1
	Left end point of transition.
const Real	_x2
	Right end point of transition.

Detailed Description

Base class for smooth transitions between two functions of one variable.

Definition at line 17 of file SmoothTransition.h.

Constructor & Destructor Documentation

SmoothTransition()

SmoothTransition::SmoothTransition	(	const Real &	x_center,
		const Real &	transition_width
	)

Constructor.

Parameters

[in]	x_center	Center point of transition
[in]	transition_width	Width of transition

Definition at line 12 of file SmoothTransition.C.

  : _x_center(x_center),
    _transition_width(transition_width),
    _x1(_x_center - 0.5 * _transition_width),
    _x2(_x_center + 0.5 * _transition_width)
{
}

Member Function Documentation

leftEnd()

const Real & SmoothTransition::leftEnd ( ) const

inline

Returns the coordinate of the left end of the transition.

Definition at line 40 of file SmoothTransition.h.

{ return _x1; }

Referenced by CubicTransitionFunction::CubicTransitionFunction(), and SmoothTransitionTestMaterial::SmoothTransitionTestMaterial().

rightEnd()

const Real & SmoothTransition::rightEnd ( ) const

inline

Returns the coordinate of the right end of the transition.

Definition at line 45 of file SmoothTransition.h.

{ return _x2; }

Referenced by CubicTransitionFunction::CubicTransitionFunction(), and SmoothTransitionTestMaterial::SmoothTransitionTestMaterial().

value()

virtual Real SmoothTransition::value ( const Real &  x, const Real &  f1, const Real &  f2  ) const

pure virtual

Computes the transition value.

Parameters

[in]	x	Point at which to evaluate function
[in]	f1	Left function
[in]	f2	Right function

Implemented in CubicTransition, and WeightedTransition.

Member Data Documentation

_transition_width

const Real SmoothTransition::_transition_width

protected

Width of transition.

Definition at line 51 of file SmoothTransition.h.

_x1

const Real SmoothTransition::_x1

protected

Left end point of transition.

Definition at line 54 of file SmoothTransition.h.

Referenced by CubicTransition::derivative(), WeightedTransition::derivative(), CubicTransition::initialize(), leftEnd(), CubicTransition::value(), WeightedTransition::value(), and WeightedTransition::weight().

_x2

const Real SmoothTransition::_x2

protected

Right end point of transition.

Definition at line 56 of file SmoothTransition.h.

Referenced by CubicTransition::derivative(), WeightedTransition::derivative(), CubicTransition::initialize(), rightEnd(), CubicTransition::value(), WeightedTransition::value(), and WeightedTransition::weight().

_x_center

const Real SmoothTransition::_x_center

protected

Center point of transition.

Definition at line 49 of file SmoothTransition.h.

---

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

• thermal_hydraulics/include/utils/SmoothTransition.h
• thermal_hydraulics/src/utils/SmoothTransition.C