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

This postporocessor calculates an estimated timestep size that limits an auxiliary variable to below a given threshold. More...

#include <MaterialTimeStepPostprocessor.h>

Inheritance diagram for MaterialTimeStepPostprocessor:
[legend]

Public Member Functions

 MaterialTimeStepPostprocessor (const InputParameters &parameters)
 
virtual void initialize ()
 
virtual void execute ()
 
virtual Real getValue ()
 
virtual void threadJoin (const UserObject &y)
 

Protected Attributes

const MaterialProperty< Real > & _matl_time_step
 
Real _value
 
unsigned int _qp
 

Detailed Description

This postporocessor calculates an estimated timestep size that limits an auxiliary variable to below a given threshold.

Definition at line 30 of file MaterialTimeStepPostprocessor.h.

Constructor & Destructor Documentation

MaterialTimeStepPostprocessor::MaterialTimeStepPostprocessor ( const InputParameters &  parameters)

Definition at line 37 of file MaterialTimeStepPostprocessor.C.

38  : ElementPostprocessor(parameters),
39  _matl_time_step(getMaterialPropertyByName<Real>("matl_timestep_limit"))
40 {
41 }
const MaterialProperty< Real > & _matl_time_step

Member Function Documentation

void MaterialTimeStepPostprocessor::execute ( )
virtual

Definition at line 50 of file MaterialTimeStepPostprocessor.C.

51 {
52  for (_qp = 0; _qp < _qrule->n_points(); _qp++)
53  _value = std::min(_value, _matl_time_step[_qp]);
54 }
const MaterialProperty< Real > & _matl_time_step
Real MaterialTimeStepPostprocessor::getValue ( )
virtual

Definition at line 57 of file MaterialTimeStepPostprocessor.C.

58 {
59  gatherMin(_value);
60  return _value;
61 }
void MaterialTimeStepPostprocessor::initialize ( )
virtual

Definition at line 44 of file MaterialTimeStepPostprocessor.C.

45 {
46  _value = std::numeric_limits<Real>::max(); // start w/ the min
47 }
void MaterialTimeStepPostprocessor::threadJoin ( const UserObject &  y)
virtual

Definition at line 64 of file MaterialTimeStepPostprocessor.C.

65 {
66  const MaterialTimeStepPostprocessor & pps = static_cast<const MaterialTimeStepPostprocessor &>(y);
67  _value = std::min(_value, pps._value);
68 }
This postporocessor calculates an estimated timestep size that limits an auxiliary variable to below ...

Member Data Documentation

const MaterialProperty<Real>& MaterialTimeStepPostprocessor::_matl_time_step
protected

Definition at line 40 of file MaterialTimeStepPostprocessor.h.

Referenced by execute().

unsigned int MaterialTimeStepPostprocessor::_qp
protected

Definition at line 43 of file MaterialTimeStepPostprocessor.h.

Referenced by execute().

Real MaterialTimeStepPostprocessor::_value
protected

Definition at line 42 of file MaterialTimeStepPostprocessor.h.

Referenced by execute(), getValue(), initialize(), and threadJoin().


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