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

Constructor & Destructor Documentation

◆ LevelSetVelocityInterface()

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

Definition at line 69 of file LevelSetVelocityInterface.h.

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

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

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

Member Data Documentation

◆ _velocity

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

Storage for velocity vector.

Definition at line 56 of file LevelSetVelocityInterface.h.

◆ _velocity_x

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

Coupled velocity variables

Definition at line 43 of file LevelSetVelocityInterface.h.

◆ _velocity_y

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

Definition at line 44 of file LevelSetVelocityInterface.h.

◆ _velocity_z

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

Definition at line 45 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 50 of file LevelSetVelocityInterface.h.

◆ _y_vel_var

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

Definition at line 51 of file LevelSetVelocityInterface.h.

◆ _z_vel_var

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

Definition at line 52 of file LevelSetVelocityInterface.h.


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