www.mooseframework.org
Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
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 >:
[legend]

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 17 of file LevelSetVelocityInterface.h.

Constructor & Destructor Documentation

template<class T >
LevelSetVelocityInterface< T >::LevelSetVelocityInterface ( const InputParameters &  parameters)

Definition at line 67 of file LevelSetVelocityInterface.h.

68  : T(parameters),
69  _velocity_x(T::coupledValue("velocity_x")),
70  _velocity_y(T::coupledValue("velocity_y")),
71  _velocity_z(T::coupledValue("velocity_z")),
72  _x_vel_var(T::coupled("velocity_x")),
73  _y_vel_var(T::coupled("velocity_y")),
74  _z_vel_var(T::coupled("velocity_z"))
75 {
76 }

Member Function Documentation

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 59 of file LevelSetVelocityInterface.h.

60 {
61  _velocity(0) = _velocity_x[T::_qp];
62  _velocity(1) = _velocity_y[T::_qp];
63  _velocity(2) = _velocity_z[T::_qp];
64 }
RealVectorValue _velocity
Storage for velocity vector.

Member Data Documentation

template<class T>
RealVectorValue LevelSetVelocityInterface< T >::_velocity
protected

Storage for velocity vector.

Definition at line 54 of file LevelSetVelocityInterface.h.

Referenced by LevelSetVelocityInterface< T >::computeQpVelocity().

template<class T>
const VariableValue& LevelSetVelocityInterface< T >::_velocity_x
protected

Coupled velocity variables

Definition at line 41 of file LevelSetVelocityInterface.h.

Referenced by LevelSetVelocityInterface< T >::computeQpVelocity().

template<class T>
const VariableValue& LevelSetVelocityInterface< T >::_velocity_y
protected
template<class T>
const VariableValue& LevelSetVelocityInterface< T >::_velocity_z
protected
template<class T>
const unsigned int LevelSetVelocityInterface< T >::_x_vel_var
protected

Coupled velocity identifiers

Definition at line 48 of file LevelSetVelocityInterface.h.

template<class T>
const unsigned int LevelSetVelocityInterface< T >::_y_vel_var
protected

Definition at line 49 of file LevelSetVelocityInterface.h.

template<class T>
const unsigned int LevelSetVelocityInterface< T >::_z_vel_var
protected

Definition at line 50 of file LevelSetVelocityInterface.h.


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