www.mooseframework.org
Public Member Functions | Protected Attributes | List of all members
StateSimRunner Class Reference

Object to start a State Simulation and manage the moose timesteping with state event times. More...

#include <StateSimRunner.h>

Inheritance diagram for StateSimRunner:
[legend]

Public Member Functions

 StateSimRunner (const InputParameters &parameters)
 
virtual void initialize () override
 
virtual void execute () override
 
virtual void finalize () override
 
Real getValue () const
 

Protected Attributes

std::string _model_path
 
StateProcessor _state_sim
 
unsigned int _next_state_time
 
bool _ran_state_sim
 

Detailed Description

Object to start a State Simulation and manage the moose timesteping with state event times.

Definition at line 23 of file StateSimRunner.h.

Constructor & Destructor Documentation

StateSimRunner::StateSimRunner ( const InputParameters &  parameters)

Definition at line 21 of file StateSimRunner.C.

22  : GeneralUserObject(parameters),
23  _model_path("model_path"),
24  _state_sim(100, parameters.get<unsigned int>("seed")), // todo max time step
25  _next_state_time(-1),
26  _ran_state_sim(false)
27 {
28  //_state_sim.setMaxTime(_dt_max); todo
30 }
std::string _model_path
unsigned int nextTime()
StateProcessor _state_sim
unsigned int _next_state_time

Member Function Documentation

void StateSimRunner::execute ( )
overridevirtual

Definition at line 38 of file StateSimRunner.C.

39 {
40  _ran_state_sim = false;
41  if ((_next_state_time > 0) && (_t_step >= (int)_next_state_time))
42  {
43  _next_state_time = _state_sim.process(_t_step);
44  _ran_state_sim = true;
45  }
46 }
StateProcessor _state_sim
unsigned int process(unsigned int time_step)
unsigned int _next_state_time
void StateSimRunner::finalize ( )
overridevirtual

Definition at line 55 of file StateSimRunner.C.

56 {
57 }
Real StateSimRunner::getValue ( ) const

Definition at line 49 of file StateSimRunner.C.

Referenced by StateSimTester::getValue().

50 {
51  return _ran_state_sim;
52 }
void StateSimRunner::initialize ( )
overridevirtual

Definition at line 33 of file StateSimRunner.C.

34 {
35 }

Member Data Documentation

std::string StateSimRunner::_model_path
protected

Definition at line 36 of file StateSimRunner.h.

unsigned int StateSimRunner::_next_state_time
protected

Definition at line 38 of file StateSimRunner.h.

Referenced by execute(), and StateSimRunner().

bool StateSimRunner::_ran_state_sim
protected

Definition at line 39 of file StateSimRunner.h.

Referenced by execute(), and getValue().

StateProcessor StateSimRunner::_state_sim
protected

Definition at line 37 of file StateSimRunner.h.

Referenced by execute(), and StateSimRunner().


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