CriticalTimeStep Class Reference

#include <CriticalTimeStep.h>

Inheritance diagram for CriticalTimeStep:

Public Member Functions
	CriticalTimeStep (const InputParameters &parameters)
virtual void	initialize () override
virtual void	execute () override
virtual void	initialSetup () override
virtual void	finalize () override
virtual Real	getValue () override
virtual void	threadJoin (const UserObject &y) override

Static Public Member Functions
static InputParameters	validParams ()

Protected Member Functions
bool	hasGuaranteedMaterialProperty (const MaterialPropertyName &prop, Guarantee guarantee)

Protected Attributes
const MaterialProperty< Real > &	_material_density
	Density of the material. More...
const MaterialProperty< Real > &	_effective_stiffness
	Effective stiffness of element: function of material properties and element size. More...
const Real &	_factor
	User defined factor to be multiplied to the critical time step. More...
Real	_critical_time
	Critical time step for explicit solver. More...

Private Attributes
const InputParameters &	_gc_params
	Parameters of the object with this interface. More...
FEProblemBase *const	_gc_feproblem
	Reference to the FEProblemBase class. More...
BlockRestrictable *const	_gc_block_restrict
	Access block restrictions of the object with this interface. More...

Detailed Description

Definition at line 27 of file CriticalTimeStep.h.

Constructor & Destructor Documentation

CriticalTimeStep()

CriticalTimeStep::CriticalTimeStep

(

const InputParameters &

parameters

)

Definition at line 29 of file CriticalTimeStep.C.

  : ElementPostprocessor(parameters),
    GuaranteeConsumer(this),
    _material_density(getMaterialPropertyByName<Real>("density")),
    _effective_stiffness(getMaterialPropertyByName<Real>("effective_stiffness")),
    _factor(getParam<Real>("factor")),
    _critical_time(parameters.isParamValid("critical_time"))
{
}

Member Function Documentation

execute()

void CriticalTimeStep::execute ( )

overridevirtual

Definition at line 54 of file CriticalTimeStep.C.

{
  Real dens = _material_density[0];
  // In the above line, density is inferred only at the first quadrature point
  // of each element. Since critical time step is computed across all elements and
  // a minimum is then taken, this is okay.
  _critical_time =
      std::min(_factor * _current_elem->hmin() * std::sqrt(dens) / (_effective_stiffness[0]),
               _critical_time);
}

finalize()

void CriticalTimeStep::finalize ( )

overridevirtual

Definition at line 66 of file CriticalTimeStep.C.

{
  gatherMin(_critical_time);
}

getValue()

Real CriticalTimeStep::getValue ( )

overridevirtual

Definition at line 72 of file CriticalTimeStep.C.

{
  return _critical_time;
}

hasGuaranteedMaterialProperty()

bool GuaranteeConsumer::hasGuaranteedMaterialProperty ( const MaterialPropertyName &  prop, Guarantee  guarantee  )

protectedinherited

Definition at line 28 of file GuaranteeConsumer.C.

{
  if (!_gc_feproblem->startedInitialSetup())
    mooseError("hasGuaranteedMaterialProperty() needs to be called in initialSetup()");
 
  // Reference to MaterialWarehouse for testing and retrieving block ids
  const auto & warehouse = _gc_feproblem->getMaterialWarehouse();
 
  // Complete set of ids that this object is active
  const auto & ids = (_gc_block_restrict && _gc_block_restrict->blockRestricted())
                         ? _gc_block_restrict->blockIDs()
                         : _gc_feproblem->mesh().meshSubdomains();
 
  // Loop over each id for this object
  for (const auto & id : ids)
  {
    // If block materials exist, look if any issue the required guarantee
    if (warehouse.hasActiveBlockObjects(id))
    {
      const std::vector<std::shared_ptr<MaterialBase>> & mats = warehouse.getActiveBlockObjects(id);
      for (const auto & mat : mats)
      {
        const auto & mat_props = mat->getSuppliedItems();
        if (mat_props.count(prop_name))
        {
          auto guarantee_mat = dynamic_cast<GuaranteeProvider *>(mat.get());
          if (guarantee_mat && !guarantee_mat->hasGuarantee(prop_name, guarantee))
          {
            // we found at least one material on the set of block we operate on
            // that does _not_ provide the requested guarantee
            return false;
          }
        }
      }
    }
  }
 
  return true;
}

Referenced by ComputeFiniteStrainElasticStress::initialSetup(), ComputeSmearedCrackingStress::initialSetup(), ComputeLinearElasticPFFractureStress::initialSetup(), initialSetup(), and ComputeMultipleInelasticStress::initialSetup().

initialize()

void CriticalTimeStep::initialize ( )

overridevirtual

Definition at line 48 of file CriticalTimeStep.C.

{
  _critical_time = std::numeric_limits<Real>::max();
}

initialSetup()

void CriticalTimeStep::initialSetup ( )

overridevirtual

Definition at line 40 of file CriticalTimeStep.C.

{
  if (!hasGuaranteedMaterialProperty("effective_stiffness", Guarantee::ISOTROPIC))
    paramError("CriticalTimeStep can only be used with elasticity tensor materials "
               "that guarantee isotropic tensors.");
}

threadJoin()

void CriticalTimeStep::threadJoin ( const UserObject &  y )

overridevirtual

Definition at line 78 of file CriticalTimeStep.C.

{
  const CriticalTimeStep & pps = static_cast<const CriticalTimeStep &>(y);
  _critical_time += pps._critical_time;
}

validParams()

InputParameters CriticalTimeStep::validParams ( )

static

Definition at line 17 of file CriticalTimeStep.C.

{
  InputParameters params = ElementPostprocessor::validParams();
  params.addClassDescription(
      "Computes and reports the critical time step for the explicit solver.");
  params.addParam<MaterialPropertyName>(
      "density",
      "Name of Material Property  or a constant real number defining the density of the material.");
  params.addParam<Real>("factor", 1.0, "Factor to mulitply to the critical time step.");
  return params;
}

Member Data Documentation

_critical_time

Real CriticalTimeStep::_critical_time

protected

Critical time step for explicit solver.

Definition at line 53 of file CriticalTimeStep.h.

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

_effective_stiffness

const MaterialProperty<Real>& CriticalTimeStep::_effective_stiffness

protected

Effective stiffness of element: function of material properties and element size.

Definition at line 47 of file CriticalTimeStep.h.

Referenced by execute().

_factor

const Real& CriticalTimeStep::_factor

protected

User defined factor to be multiplied to the critical time step.

Definition at line 50 of file CriticalTimeStep.h.

Referenced by execute().

_gc_block_restrict

BlockRestrictable* const GuaranteeConsumer::_gc_block_restrict

privateinherited

Access block restrictions of the object with this interface.

Definition at line 41 of file GuaranteeConsumer.h.

Referenced by GuaranteeConsumer::hasGuaranteedMaterialProperty().

_gc_feproblem

FEProblemBase* const GuaranteeConsumer::_gc_feproblem

privateinherited

Reference to the FEProblemBase class.

Definition at line 38 of file GuaranteeConsumer.h.

Referenced by GuaranteeConsumer::hasGuaranteedMaterialProperty().

_gc_params

const InputParameters& GuaranteeConsumer::_gc_params

privateinherited

Parameters of the object with this interface.

Definition at line 35 of file GuaranteeConsumer.h.

_material_density

const MaterialProperty<Real>& CriticalTimeStep::_material_density

protected

Density of the material.

Definition at line 44 of file CriticalTimeStep.h.

Referenced by execute().

---

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

• tensor_mechanics/include/postprocessors/CriticalTimeStep.h
• tensor_mechanics/src/postprocessors/CriticalTimeStep.C