NSAction Class Reference

This is a base Action class for the Navier-Stokes module which is responsible for building lists of names that other Actions can subsequently use. More...

#include <NSAction.h>

Inheritance diagram for NSAction:

Public Member Functions
	NSAction (InputParameters parameters)
virtual	~NSAction ()
virtual void	act ()

Protected Types
typedef std::vector< VariableName >	CoupledName

Protected Attributes
std::vector< std::string >	_vars
std::vector< std::string >	_auxs
unsigned int	_dim

Detailed Description

This is a base Action class for the Navier-Stokes module which is responsible for building lists of names that other Actions can subsequently use.

Subclasses should call its act() function prior to doing their own work.

Definition at line 25 of file NSAction.h.

Member Typedef Documentation

CoupledName

typedef std::vector<VariableName> NSAction::CoupledName

protected

Definition at line 42 of file NSAction.h.

Constructor & Destructor Documentation

NSAction()

NSAction::NSAction

(

InputParameters

parameters

)

Definition at line 30 of file NSAction.C.

: Action(parameters), _dim(0) {}

~NSAction()

NSAction::~NSAction ( )

virtual

Definition at line 32 of file NSAction.C.

{}

Member Function Documentation

act()

void NSAction::act ( )

virtual

Reimplemented in AddNavierStokesICsAction, AddNavierStokesVariablesAction, and AddNavierStokesKernelsAction.

Definition at line 35 of file NSAction.C.

{
  _vars.clear();
  _auxs.clear();
 
  _dim = _mesh->dimension();
 
  // Build up the vector of variable names for the user, depending on
  // the mesh dimension.
  _vars.push_back(NS::density);
  _vars.push_back(NS::momentum_x);
  if (_dim >= 2)
    _vars.push_back(NS::momentum_y);
  if (_dim >= 3)
    _vars.push_back(NS::momentum_z);
  _vars.push_back(NS::total_energy);
 
  // Add Aux variables.  These are all required in order for the code
  // to run, so they should not be independently selectable by the
  // user.
  _auxs.push_back(NS::velocity_x);
  if (_dim >= 2)
    _auxs.push_back(NS::velocity_y);
  if (_dim >= 3)
    _auxs.push_back(NS::velocity_z);
 
  _auxs.push_back(NS::pressure);
  _auxs.push_back(NS::temperature);
  _auxs.push_back(NS::enthalpy);
  _auxs.push_back(NS::mach_number);
 
  // Needed for FluidProperties calculations
  _auxs.push_back(NS::internal_energy);
  _auxs.push_back(NS::specific_volume);
}

Referenced by AddNavierStokesKernelsAction::act(), AddNavierStokesVariablesAction::act(), and AddNavierStokesICsAction::act().

Member Data Documentation

_auxs

std::vector<std::string> NSAction::_auxs

protected

Definition at line 35 of file NSAction.h.

Referenced by act(), AddNavierStokesVariablesAction::act(), and AddNavierStokesICsAction::act().

_dim

unsigned int NSAction::_dim

protected

Definition at line 39 of file NSAction.h.

Referenced by act(), AddNavierStokesKernelsAction::act(), AddNavierStokesKernelsAction::coupleMomentums(), and AddNavierStokesKernelsAction::coupleVelocities().

_vars

std::vector<std::string> NSAction::_vars

protected

Definition at line 34 of file NSAction.h.

Referenced by act(), AddNavierStokesKernelsAction::act(), AddNavierStokesVariablesAction::act(), and AddNavierStokesICsAction::act().

---

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

• navier_stokes/include/actions/NSAction.h
• navier_stokes/src/actions/NSAction.C