NekInitAction Class Reference

#include <NekInitAction.h>

Inheritance diagram for NekInitAction:

Public Member Functions
	NekInitAction (const InputParameters &parameters)
virtual void	act () override

Static Public Member Functions
static InputParameters	validParams ()

Protected Member Functions
inipp::Ini *	readPar (const std::string &_setupFile, MPI_Comm comm)

Protected Attributes
const bool	_specified_scratch
	whether the user specified how many scratch slots to allocate More...
const unsigned int &	_n_usrwrk_slots

Static Protected Attributes
static int	_n_cases
	number of NekRS cases created More...

Detailed Description

Initialize Nek application by calling nekrs::setup. This needs to be in an action so that it occurs before the [Mesh] is constructed (which is normally the first MOOSE object constructed) because we build the [Mesh] relying on internal stuff in NekRS, which needs to be initialized at that point.

Constructor & Destructor Documentation

NekInitAction()

NekInitAction::NekInitAction

(

const InputParameters &

parameters

)

Member Function Documentation

act()

virtual void NekInitAction::act ( )

overridevirtual

readPar()

inipp::Ini* NekInitAction::readPar ( const std::string &  _setupFile, MPI_Comm  comm  )

protected

Copied from NekRS because they do not want to move this to a file other than main.cpp :|

validParams()

static InputParameters NekInitAction::validParams ( )

static

Member Data Documentation

_n_cases

int NekInitAction::_n_cases

staticprotected

number of NekRS cases created

_n_usrwrk_slots

const unsigned int& NekInitAction::_n_usrwrk_slots

protected

Number of slices/slots to allocate in nrs->usrwrk to hold fields for coupling (i.e. data going into NekRS, written by Cardinal), or used for custom user actions, but not for coupling. By default, we just allocate 7 slots (no inherent reason, just a fairly big amount). For memory-limited cases, you can reduce this number to just the bare minimum necessary for your use case.

_specified_scratch

const bool NekInitAction::_specified_scratch

protected

whether the user specified how many scratch slots to allocate

---

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

• include/actions/NekInitAction.h