WeightedTransition Class Reference

Weighted transition between two functions of one variable. More...

#include <WeightedTransition.h>

Inheritance diagram for WeightedTransition:

Public Member Functions
	WeightedTransition (const Real &x_center, const Real &transition_width)
	Constructor. More...
virtual Real	value (const Real &x, const Real &f1, const Real &f2) const override
	Computes the transition value. More...
Real	derivative (const Real &x, const Real &f1, const Real &f2, const Real &df1dx, const Real &df2dx) const
	Computes the derivative of the transition value. More...
Real	weight (const Real &x) const
	Computes the weight of the first function. More...
const Real &	leftEnd () const
	Returns the coordinate of the left end of the transition. More...
const Real &	rightEnd () const
	Returns the coordinate of the right end of the transition. More...

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

Detailed Description

Weighted transition between two functions of one variable.

Definition at line 17 of file WeightedTransition.h.

Constructor & Destructor Documentation

WeightedTransition()

WeightedTransition::WeightedTransition	(	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 WeightedTransition.C.

  : SmoothTransition(x_center, transition_width)
{
}

Member Function Documentation

derivative()

Real WeightedTransition::derivative	(	const Real &	x,
		const Real &	f1,
		const Real &	f2,
		const Real &	df1dx,
		const Real &	df2dx
	)		const

Computes the derivative of the transition value.

Parameters

[in]	x	Point at which to evaluate transition
[in]	f1	First function value
[in]	f2	Second function value
[in]	df1dx	First function derivative
[in]	df2dx	Second function derivative

Definition at line 32 of file WeightedTransition.C.

Referenced by SmoothTransitionTestMaterial::computeQpProperties().

{
  if (x <= _x1)
    return df1dx;
  else if (x >= _x2)
    return df2dx;
  else
  {
    const Real w = weight(x);
    const Real dwdx = -0.5 * std::sin(M_PI / (_x2 - _x1) * (x - _x1)) * M_PI / (_x2 - _x1);
    return w * df1dx + (1.0 - w) * df2dx + dwdx * (f1 - f2);
  }
}

leftEnd()

const Real& SmoothTransition::leftEnd ( ) const

inlineinherited

Returns the coordinate of the left end of the transition.

Definition at line 40 of file SmoothTransition.h.

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

{ return _x1; }

rightEnd()

const Real& SmoothTransition::rightEnd ( ) const

inlineinherited

Returns the coordinate of the right end of the transition.

Definition at line 45 of file SmoothTransition.h.

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

{ return _x2; }

value()

Real WeightedTransition::value ( const Real &  x, const Real &  f1, const Real &  f2  ) const

overridevirtual

Computes the transition value.

Parameters

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

Implements SmoothTransition.

Definition at line 18 of file WeightedTransition.C.

Referenced by SmoothTransitionTestMaterial::computeQpProperties(), and CosineTransitionFunction::value().

{
  if (x <= _x1)
    return f1;
  else if (x >= _x2)
    return f2;
  else
  {
    const Real w = weight(x);
    return w * f1 + (1.0 - w) * f2;
  }
}

weight()

Real WeightedTransition::weight

(

const Real &

x

)

const

Computes the weight of the first function.

Parameters

[in]

x

Point at which to evaluate weight

Definition at line 48 of file WeightedTransition.C.

Referenced by derivative(), and value().

{
  return 0.5 * (std::cos(M_PI / (_x2 - _x1) * (x - _x1)) + 1.0);
}

Member Data Documentation

_transition_width

const Real SmoothTransition::_transition_width

protectedinherited

Width of transition.

Definition at line 51 of file SmoothTransition.h.

_x1

const Real SmoothTransition::_x1

protectedinherited

Left end point of transition.

Definition at line 54 of file SmoothTransition.h.

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

_x2

const Real SmoothTransition::_x2

protectedinherited

Right end point of transition.

Definition at line 56 of file SmoothTransition.h.

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

_x_center

const Real SmoothTransition::_x_center

protectedinherited

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/WeightedTransition.h
• thermal_hydraulics/src/utils/WeightedTransition.C