AddNavierStokesVariablesAction Class Reference

This class allows us to have a section of the input file like the following which automatically adds all the required nonlinear variables with the appropriate scaling. More...

#include <AddNavierStokesVariablesAction.h>

Inheritance diagram for AddNavierStokesVariablesAction:

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

Protected Types
typedef std::vector< VariableName >	CoupledName

Protected Attributes
std::vector< Real >	_scaling
std::vector< SubdomainName >	_blocks
std::vector< std::string >	_vars
std::vector< std::string >	_auxs
unsigned int	_dim

Detailed Description

This class allows us to have a section of the input file like the following which automatically adds all the required nonlinear variables with the appropriate scaling.

[NavierStokes] [./Variables]

'rho rhou rhov rhoE'

scaling = '1. 1. 1. 9.869232667160121e-6' family = LAGRANGE order = FIRST [../] []

Definition at line 33 of file AddNavierStokesVariablesAction.h.

Member Typedef Documentation

CoupledName

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

protectedinherited

Definition at line 42 of file NSAction.h.

Constructor & Destructor Documentation

AddNavierStokesVariablesAction()

AddNavierStokesVariablesAction::AddNavierStokesVariablesAction

(

InputParameters

parameters

)

Definition at line 50 of file AddNavierStokesVariablesAction.C.

  : NSAction(parameters),
    _scaling(getParam<std::vector<Real>>("scaling")),
    _blocks(getParam<std::vector<SubdomainName>>("block"))
{
}

~AddNavierStokesVariablesAction()

AddNavierStokesVariablesAction::~AddNavierStokesVariablesAction ( )

virtual

Definition at line 57 of file AddNavierStokesVariablesAction.C.

{}

Member Function Documentation

act()

void AddNavierStokesVariablesAction::act ( )

virtual

Reimplemented from NSAction.

Definition at line 60 of file AddNavierStokesVariablesAction.C.

{
  // Call the base class's act() function to initialize the _vars and _auxs names.
  NSAction::act();
 
  // Make sure the number of scaling parameters matches the number of variables
  if (_scaling.size() != _vars.size())
    mooseError("Must provide a scaling parameter for each variable.");
 
  // All variables have the same type
  FEType fe_type(Utility::string_to_enum<Order>(getParam<MooseEnum>("order")),
                 Utility::string_to_enum<FEFamily>(getParam<MooseEnum>("family")));
 
  std::set<SubdomainID> _block_ids;
  for (const auto & subdomain_name : _blocks)
  {
    SubdomainID id = _mesh->getSubdomainID(subdomain_name);
    _block_ids.insert(id);
  }
 
  auto var_type = AddVariableAction::determineType(fe_type, 1);
  auto base_params = _factory.getValidParams(var_type);
  base_params.set<MooseEnum>("order") = fe_type.order.get_order();
  base_params.set<MooseEnum>("family") = Moose::stringify(fe_type.family);
  if (_block_ids.size() != 0)
    for (const SubdomainID & id : _block_ids)
      base_params.set<std::vector<SubdomainName>>("block").push_back(Moose::stringify(id));
 
  // Add the variables to the FEProblemBase
  for (unsigned int i = 0; i < _vars.size(); ++i)
  {
    InputParameters var_params(base_params);
    var_params.set<std::vector<Real>>("scaling") = {_scaling[i]};
    _problem->addVariable(var_type, _vars[i], var_params);
  }
 
  // Add Aux variables.  These are all required in order for the code
  // to run, so they should not be independently selectable by the
  // user.
  for (const auto & aux_name : _auxs)
    _problem->addAuxVariable(var_type, aux_name, base_params);
}

Member Data Documentation

_auxs

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

protectedinherited

Definition at line 35 of file NSAction.h.

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

_blocks

std::vector<SubdomainName> AddNavierStokesVariablesAction::_blocks

protected

Definition at line 43 of file AddNavierStokesVariablesAction.h.

Referenced by act().

_dim

unsigned int NSAction::_dim

protectedinherited

Definition at line 39 of file NSAction.h.

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

_scaling

std::vector<Real> AddNavierStokesVariablesAction::_scaling

protected

Definition at line 42 of file AddNavierStokesVariablesAction.h.

Referenced by act().

_vars

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

protectedinherited

Definition at line 34 of file NSAction.h.

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

---

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

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