InitialConditionInterface Class Reference

InitialConditionInterface serves as the abstract class for InitialConditions, FVInitialConditions, and ScalarInitialConditions. More...

#include <InitialConditionInterface.h>

Inheritance diagram for InitialConditionInterface:

Public Member Functions
	InitialConditionInterface (const InputParameters &parameters)
	Constructor.
virtual	~InitialConditionInterface ()
unsigned short	getState () const
	Retrieves the state of this initial condition.

Static Public Member Functions
static InputParameters	validParams ()

Protected Attributes
unsigned short	_my_state

Detailed Description

InitialConditionInterface serves as the abstract class for InitialConditions, FVInitialConditions, and ScalarInitialConditions.

Definition at line 18 of file InitialConditionInterface.h.

Constructor & Destructor Documentation

InitialConditionInterface()

InitialConditionInterface::InitialConditionInterface

(

const InputParameters &

parameters

)

Constructor.

Parameters

parameters

The parameters object holding data for the class to use.

Definition at line 34 of file InitialConditionInterface.C.

  : _my_state(parameters.get<MooseEnum>("state"))
{
}

~InitialConditionInterface()

InitialConditionInterface::~InitialConditionInterface ( )

virtual

Definition at line 39 of file InitialConditionInterface.C.

{}

Member Function Documentation

getState()

unsigned short InitialConditionInterface::getState

(

)

const

Retrieves the state of this initial condition.

Returns

The state of this initial condition.

Definition at line 42 of file InitialConditionInterface.C.

{
  return _my_state;
}

validParams()

InputParameters InitialConditionInterface::validParams ( )

static

Definition at line 15 of file InitialConditionInterface.C.

{
  InputParameters params = emptyInputParameters();
 
  MooseEnum stateEnum("CURRENT=0 OLD=1 OLDER=2", "CURRENT");
  params.addParam<MooseEnum>(
      "state",
      stateEnum,
      "This parameter is used to set old state solutions at the start of simulation. If specifying "
      "multiple states at the start of simulation, use one IC object for each state being "
      "specified. The states are CURRENT=0 OLD=1 OLDER=2. States older than 2 are not currently "
      "supported. When the user only specifies current state, the solution is copied to the old "
      "and older states, as expected. This functionality is mainly used for dynamic simulations "
      "with explicit time integration schemes, where old solution states are used in the velocity "
      "and acceleration approximations.");
 
  return params;
}

Referenced by FVInitialConditionBase::validParams(), InitialConditionBase::validParams(), and ScalarInitialCondition::validParams().

Member Data Documentation

_my_state

unsigned short InitialConditionInterface::_my_state

protected

Definition at line 40 of file InitialConditionInterface.h.

Referenced by getState().

---

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

• include/ics/InitialConditionInterface.h
• src/ics/InitialConditionInterface.C