ADCubicTransition Class Reference

Cubic polynomial transition between two functions of one variable. More...

#include <ADCubicTransition.h>

Inheritance diagram for ADCubicTransition:

Public Member Functions
	ADCubicTransition (const ADReal &x_center, const ADReal &transition_width)
	Constructor. More...
virtual ADReal	value (const ADReal &x, const ADReal &f1, const ADReal &f2) const override
	Computes the transition value. More...
void	initialize (const ADReal &f1_end_value, const ADReal &f2_end_value, const ADReal &df1dx_end_value, const ADReal &df2dx_end_value)
	Computes the derivative of the transition value. More...
const ADReal &	leftEnd () const
	Returns the coordinate of the left end of the transition. More...
const ADReal &	rightEnd () const
	Returns the coordinate of the right end of the transition. More...

Protected Attributes
ADReal	_A
ADReal	_B
ADReal	_C
ADReal	_D
bool	_initialized
	Flag that transition has been initialized. More...
const ADReal	_x_center
	Center point of transition. More...
const ADReal	_transition_width
	Width of transition. More...
const ADReal	_x1
	Left end point of transition. More...
const ADReal	_x2
	Right end point of transition. More...

Detailed Description

Cubic polynomial transition between two functions of one variable.

Definition at line 17 of file ADCubicTransition.h.

Constructor & Destructor Documentation

ADCubicTransition()

ADCubicTransition::ADCubicTransition	(	const ADReal &	x_center,
		const ADReal &	transition_width
	)

Constructor.

Parameters

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

Definition at line 17 of file ADCubicTransition.C.

  : ADSmoothTransition(x_center, transition_width),

    _A(0.0),
    _B(0.0),
    _C(0.0),
    _D(0.0),

    _initialized(false)
{
}

Member Function Documentation

initialize()

void ADCubicTransition::initialize	(	const ADReal &	f1_end_value,
		const ADReal &	f2_end_value,
		const ADReal &	df1dx_end_value,
		const ADReal &	df2dx_end_value
	)

Computes the derivative of the transition value.

Parameters

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

Definition at line 30 of file ADCubicTransition.C.

Referenced by ADSmoothTransitionTestMaterial::ADSmoothTransitionTestMaterial().

{
  // compute cubic polynomial coefficients
  using std::pow;

  DenseMatrix<ADReal> mat(4, 4);

  mat(0, 0) = pow(_x1, 3);
  mat(0, 1) = pow(_x1, 2);
  mat(0, 2) = _x1;
  mat(0, 3) = 1.0;

  mat(1, 0) = pow(_x2, 3);
  mat(1, 1) = pow(_x2, 2);
  mat(1, 2) = _x2;
  mat(1, 3) = 1.0;

  mat(2, 0) = 3.0 * pow(_x1, 2);
  mat(2, 1) = 2.0 * _x1;
  mat(2, 2) = 1.0;
  mat(2, 3) = 0.0;

  mat(3, 0) = 3.0 * pow(_x2, 2);
  mat(3, 1) = 2.0 * _x2;
  mat(3, 2) = 1.0;
  mat(3, 3) = 0.0;

  DenseVector<ADReal> rhs(4);
  rhs(0) = f1_end_value;
  rhs(1) = f2_end_value;
  rhs(2) = df1dx_end_value;
  rhs(3) = df2dx_end_value;

  DenseVector<ADReal> coefs(4);
  mat.lu_solve(rhs, coefs);

  _A = coefs(0);
  _B = coefs(1);
  _C = coefs(2);
  _D = coefs(3);

  _initialized = true;
}

leftEnd()

const ADReal& ADSmoothTransition::leftEnd ( ) const

inlineinherited

Returns the coordinate of the left end of the transition.

Definition at line 40 of file ADSmoothTransition.h.

Referenced by ADSmoothTransitionTestMaterial::ADSmoothTransitionTestMaterial(), and ADShaftConnectedPump1PhaseUserObject::computeFluxesAndResiduals().

{ return _x1; }

rightEnd()

const ADReal& ADSmoothTransition::rightEnd ( ) const

inlineinherited

Returns the coordinate of the right end of the transition.

Definition at line 45 of file ADSmoothTransition.h.

Referenced by ADSmoothTransitionTestMaterial::ADSmoothTransitionTestMaterial(), and ADShaftConnectedPump1PhaseUserObject::computeFluxesAndResiduals().

{ return _x2; }

value()

ADReal ADCubicTransition::value ( const ADReal &  x, const ADReal &  f1, const ADReal &  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 ADSmoothTransition.

Definition at line 78 of file ADCubicTransition.C.

Referenced by ADSmoothTransitionTestMaterial::computeQpProperties().

{
  mooseAssert(_initialized, "initialize() must be called.");
  using std::pow;

  if (x <= _x1)
    return f1;
  else if (x >= _x2)
    return f2;
  else
    return _A * pow(x, 3) + _B * pow(x, 2) + _C * x + _D;
}

Member Data Documentation

_A

ADReal ADCubicTransition::_A

protected

Definition at line 44 of file ADCubicTransition.h.

Referenced by initialize(), and value().

_B

ADReal ADCubicTransition::_B

protected

Definition at line 45 of file ADCubicTransition.h.

Referenced by initialize(), and value().

_C

ADReal ADCubicTransition::_C

protected

Definition at line 46 of file ADCubicTransition.h.

Referenced by initialize(), and value().

_D

ADReal ADCubicTransition::_D

protected

Definition at line 47 of file ADCubicTransition.h.

Referenced by initialize(), and value().

_initialized

bool ADCubicTransition::_initialized

protected

Flag that transition has been initialized.

Definition at line 50 of file ADCubicTransition.h.

Referenced by initialize(), and value().

_transition_width

const ADReal ADSmoothTransition::_transition_width

protectedinherited

Width of transition.

Definition at line 51 of file ADSmoothTransition.h.

_x1

const ADReal ADSmoothTransition::_x1

protectedinherited

Left end point of transition.

Definition at line 54 of file ADSmoothTransition.h.

Referenced by initialize(), ADSmoothTransition::leftEnd(), ADWeightedTransition::value(), value(), and ADWeightedTransition::weight().

_x2

const ADReal ADSmoothTransition::_x2

protectedinherited

Right end point of transition.

Definition at line 56 of file ADSmoothTransition.h.

Referenced by initialize(), ADSmoothTransition::rightEnd(), ADWeightedTransition::value(), value(), and ADWeightedTransition::weight().

_x_center

const ADReal ADSmoothTransition::_x_center

protectedinherited

Center point of transition.

Definition at line 49 of file ADSmoothTransition.h.

---

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

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