LevelSetVelocityInterface< T > Class Template Reference

A helper class for defining the velocity as coupled variables for the levelset equation. More...

#include <LevelSetVelocityInterface.h>

Inheritance diagram for LevelSetVelocityInterface< T >:

Public Member Functions
	LevelSetVelocityInterface (const InputParameters &parameters)

Protected Member Functions
void	computeQpVelocity ()
	This method should be called when the velocity vector needs to be updated, this is not done automatically to avoid populating a vector that is not used. More...

Protected Attributes
RealVectorValue	_velocity
	Storage for velocity vector. More...
const VariableValue &	_velocity_x
const VariableValue &	_velocity_y
const VariableValue &	_velocity_z
const unsigned int	_x_vel_var
const unsigned int	_y_vel_var
const unsigned int	_z_vel_var

Detailed Description

template<class T>
class LevelSetVelocityInterface< T >

A helper class for defining the velocity as coupled variables for the levelset equation.

Definition at line 18 of file LevelSetVelocityInterface.h.

Constructor & Destructor Documentation

LevelSetVelocityInterface()

template<class T >

LevelSetVelocityInterface< T >::LevelSetVelocityInterface

(

const InputParameters &

parameters

)

Definition at line 68 of file LevelSetVelocityInterface.h.

  : T(parameters),
    _velocity_x(T::coupledValue("velocity_x")),
    _velocity_y(T::coupledValue("velocity_y")),
    _velocity_z(T::coupledValue("velocity_z")),
    _x_vel_var(T::coupled("velocity_x")),
    _y_vel_var(T::coupled("velocity_y")),
    _z_vel_var(T::coupled("velocity_z"))
{
}

Member Function Documentation

computeQpVelocity()

template<class T >

void LevelSetVelocityInterface< T >::computeQpVelocity ( )

protected

This method should be called when the velocity vector needs to be updated, this is not done automatically to avoid populating a vector that is not used.

Definition at line 60 of file LevelSetVelocityInterface.h.

{
  _velocity(0) = _velocity_x[T::_qp];
  _velocity(1) = _velocity_y[T::_qp];
  _velocity(2) = _velocity_z[T::_qp];
}

Member Data Documentation

_velocity

template<class T>

RealVectorValue LevelSetVelocityInterface< T >::_velocity

protected

Storage for velocity vector.

Definition at line 55 of file LevelSetVelocityInterface.h.

_velocity_x

template<class T>

const VariableValue& LevelSetVelocityInterface< T >::_velocity_x

protected

Coupled velocity variables

Definition at line 42 of file LevelSetVelocityInterface.h.

_velocity_y

template<class T>

const VariableValue& LevelSetVelocityInterface< T >::_velocity_y

protected

Definition at line 43 of file LevelSetVelocityInterface.h.

_velocity_z

template<class T>

const VariableValue& LevelSetVelocityInterface< T >::_velocity_z

protected

Definition at line 44 of file LevelSetVelocityInterface.h.

_x_vel_var

template<class T>

const unsigned int LevelSetVelocityInterface< T >::_x_vel_var

protected

Coupled velocity identifiers

Definition at line 49 of file LevelSetVelocityInterface.h.

_y_vel_var

template<class T>

const unsigned int LevelSetVelocityInterface< T >::_y_vel_var

protected

Definition at line 50 of file LevelSetVelocityInterface.h.

_z_vel_var

template<class T>

const unsigned int LevelSetVelocityInterface< T >::_z_vel_var

protected

Definition at line 51 of file LevelSetVelocityInterface.h.

---

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

• level_set/include/interfaces/LevelSetVelocityInterface.h