PorosityFromStrain.C

Go to the documentation of this file.

//* This file is part of the MOOSE framework
//* https://mooseframework.inl.gov
//*
//* All rights reserved, see COPYRIGHT for full restrictions
//* https://github.com/idaholab/moose/blob/master/COPYRIGHT
//*
//* Licensed under LGPL 2.1, please see LICENSE for details
//* https://www.gnu.org/licenses/lgpl-2.1.html

#include "PorosityFromStrain.h"

registerMooseObject("SolidMechanicsApp", PorosityFromStrain);
registerMooseObject("SolidMechanicsApp", ADPorosityFromStrain);

template <bool is_ad>
InputParameters
PorosityFromStrainTempl<is_ad>::validParams()
{
  InputParameters params = Material::validParams();

  params.addClassDescription("Porosity calculation from the inelastic strain.");

  params.addParam<MaterialPropertyName>(
      "porosity_name", "porosity", "Name of porosity material property");
  params.addRequiredRangeCheckedParam<Real>(
      "initial_porosity", "initial_porosity>=0.0 & initial_porosity<1.0", "Initial porosity");
  params.addRequiredParam<MaterialPropertyName>("inelastic_strain",
                                                "Name of the combined inelastic strain");
  MooseEnum negative_behavior("ZERO INITIAL_CONDITION EXCEPTION", "INITIAL_CONDITION");
  params.addParam<MooseEnum>(
      "negative_behavior", negative_behavior, "Enum how to handle negative porosities");

  return params;
}

template <bool is_ad>
PorosityFromStrainTempl<is_ad>::PorosityFromStrainTempl(const InputParameters & parameters)
  : Material(parameters),
    _porosity(declareGenericProperty<Real, is_ad>(getParam<MaterialPropertyName>("porosity_name"))),
    _porosity_old(getMaterialPropertyOld<Real>("porosity_name")),
    _initial_porosity(getParam<Real>("initial_porosity")),
    _inelastic_strain(getGenericMaterialProperty<RankTwoTensor, is_ad>("inelastic_strain")),
    _inelastic_strain_old(getMaterialPropertyOld<RankTwoTensor>("inelastic_strain")),
    _negative_behavior(this->template getParam<MooseEnum>("negative_behavior")
                           .template getEnum<NegativeBehavior>())
{
}

template <bool is_ad>
void
PorosityFromStrainTempl<is_ad>::initQpStatefulProperties()
{
  _porosity[_qp] = _initial_porosity;
}

template <bool is_ad>
void
PorosityFromStrainTempl<is_ad>::computeQpProperties()
{
  _porosity[_qp] =
      (1.0 - _porosity_old[_qp]) * (_inelastic_strain[_qp] - _inelastic_strain_old[_qp]).trace() +
      _porosity_old[_qp];

  if (_porosity[_qp] < 0.0)
  {
    if (_negative_behavior == NegativeBehavior::ZERO)
      _porosity[_qp] = 0.0;
    if (_negative_behavior == NegativeBehavior::INITIAL_CONDITION)
      _porosity[_qp] = _initial_porosity;
    if (_negative_behavior == NegativeBehavior::EXCEPTION)
      mooseException("In ", _name, ": porosity is negative.");
  }

  if (std::isnan(_porosity[_qp]))
    mooseException("In ", _name, ": porosity is nan. Cutting timestep.");
}