www.mooseframework.org
Public Member Functions | Protected Attributes | List of all members
ExecStore< T > Class Template Reference

The class for storing warehouses that holds objects that are being evaluated at different times. More...

#include <ExecStore.h>

Public Member Functions

 ExecStore ()
 
std::vector< T > & operator() (ExecFlagType type)
 Parenthesis operator for accessing the warehouses for different times. More...
 

Protected Attributes

std::vector< T > _obj_initial
 executed once at the beginning of the simulation More...
 
std::vector< T > _obj_linear
 executed every residual evaluation More...
 
std::vector< T > _obj_nonlinear
 executed every jacobian (nonlinear) evaluation More...
 
std::vector< T > _obj_timestep_end
 executed at the end of every time step More...
 
std::vector< T > _obj_timestep_begin
 executed at the beginning of every time step More...
 
std::vector< T > _obj_custom
 executed at a custom time by the Executioner More...
 

Detailed Description

template<typename T>
class ExecStore< T >

The class for storing warehouses that holds objects that are being evaluated at different times.

Currently we can do only Post-processors and AuxKernels, but this object will help to extend the other subsystems.

Definition at line 31 of file ExecStore.h.

Constructor & Destructor Documentation

template<typename T >
ExecStore< T >::ExecStore ( )
inline

Definition at line 34 of file ExecStore.h.

35  : _obj_initial(libMesh::n_threads()),
36  _obj_linear(libMesh::n_threads()),
37  _obj_nonlinear(libMesh::n_threads()),
38  _obj_timestep_end(libMesh::n_threads()),
39  _obj_timestep_begin(libMesh::n_threads()),
40  _obj_custom(libMesh::n_threads())
41  {
42  }
std::vector< T > _obj_custom
executed at a custom time by the Executioner
Definition: ExecStore.h:81
std::vector< T > _obj_timestep_begin
executed at the beginning of every time step
Definition: ExecStore.h:79
std::vector< T > _obj_linear
executed every residual evaluation
Definition: ExecStore.h:73
std::vector< T > _obj_timestep_end
executed at the end of every time step
Definition: ExecStore.h:77
std::vector< T > _obj_nonlinear
executed every jacobian (nonlinear) evaluation
Definition: ExecStore.h:75
std::vector< T > _obj_initial
executed once at the beginning of the simulation
Definition: ExecStore.h:71

Member Function Documentation

template<typename T >
std::vector<T>& ExecStore< T >::operator() ( ExecFlagType  type)
inline

Parenthesis operator for accessing the warehouses for different times.

Parameters
type
Returns

Definition at line 49 of file ExecStore.h.

50  {
51  switch (type)
52  {
53  case EXEC_INITIAL:
54  return _obj_initial;
55  case EXEC_TIMESTEP_END:
56  return _obj_timestep_end;
58  return _obj_timestep_begin;
59  case EXEC_NONLINEAR:
60  return _obj_nonlinear;
61  case EXEC_CUSTOM:
62  return _obj_custom;
63  case EXEC_LINEAR:
64  default:
65  return _obj_linear;
66  }
67  }
Object is evaluated in every residual computation.
Definition: MooseTypes.h:96
std::vector< T > _obj_custom
executed at a custom time by the Executioner
Definition: ExecStore.h:81
std::vector< T > _obj_timestep_begin
executed at the beginning of every time step
Definition: ExecStore.h:79
For use with custom executioners that want to fire objects at a specific time.
Definition: MooseTypes.h:110
Object is evaluated only once at the beginning of the simulation.
Definition: MooseTypes.h:94
std::vector< T > _obj_linear
executed every residual evaluation
Definition: ExecStore.h:73
Object is evaluated at the end of every time step.
Definition: MooseTypes.h:100
std::vector< T > _obj_timestep_end
executed at the end of every time step
Definition: ExecStore.h:77
std::vector< T > _obj_nonlinear
executed every jacobian (nonlinear) evaluation
Definition: ExecStore.h:75
std::vector< T > _obj_initial
executed once at the beginning of the simulation
Definition: ExecStore.h:71
MatType type
Object is evaluated at the beginning of every time step.
Definition: MooseTypes.h:102
Object is evaluated in every jacobian computation.
Definition: MooseTypes.h:98

Member Data Documentation

template<typename T >
std::vector<T> ExecStore< T >::_obj_custom
protected

executed at a custom time by the Executioner

Definition at line 81 of file ExecStore.h.

Referenced by ExecStore< T >::operator()().

template<typename T >
std::vector<T> ExecStore< T >::_obj_initial
protected

executed once at the beginning of the simulation

Definition at line 71 of file ExecStore.h.

Referenced by ExecStore< T >::operator()().

template<typename T >
std::vector<T> ExecStore< T >::_obj_linear
protected

executed every residual evaluation

Definition at line 73 of file ExecStore.h.

Referenced by ExecStore< T >::operator()().

template<typename T >
std::vector<T> ExecStore< T >::_obj_nonlinear
protected

executed every jacobian (nonlinear) evaluation

Definition at line 75 of file ExecStore.h.

Referenced by ExecStore< T >::operator()().

template<typename T >
std::vector<T> ExecStore< T >::_obj_timestep_begin
protected

executed at the beginning of every time step

Definition at line 79 of file ExecStore.h.

Referenced by ExecStore< T >::operator()().

template<typename T >
std::vector<T> ExecStore< T >::_obj_timestep_end
protected

executed at the end of every time step

Definition at line 77 of file ExecStore.h.

Referenced by ExecStore< T >::operator()().


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