#include <GeneralizedPlaneStrainReferenceResidual.h>

Inheritance diagram for GeneralizedPlaneStrainReferenceResidual:

Public Member Functions
	GeneralizedPlaneStrainReferenceResidual (const InputParameters &parameters)

virtual Real	computeValue () override

Static Public Member Functions
static InputParameters	validParams ()

Public Attributes
const GeneralizedPlaneStrainUserObject &	_gps

const unsigned int	_scalar_var_id

Detailed Description

Definition at line 21 of file GeneralizedPlaneStrainReferenceResidual.h.

Constructor & Destructor Documentation

◆ GeneralizedPlaneStrainReferenceResidual()

GeneralizedPlaneStrainReferenceResidual::GeneralizedPlaneStrainReferenceResidual ( const InputParameters & parameters )

Definition at line 36 of file GeneralizedPlaneStrainReferenceResidual.C.

   : AuxScalarKernel(parameters),
     _gps(getUserObject<GeneralizedPlaneStrainUserObject>("generalized_plane_strain")),
     _scalar_var_id(isParamValid("scalar_out_of_plane_strain_index")
                        ? getParam<unsigned int>("scalar_out_of_plane_strain_index")
                        : 0)
 {
 }

Member Function Documentation

◆ computeValue()

Real GeneralizedPlaneStrainReferenceResidual::computeValue ( )

overridevirtual

Definition at line 47 of file GeneralizedPlaneStrainReferenceResidual.C.

 {
   return _gps.returnReferenceResidual(_scalar_var_id);
 }

◆ validParams()

InputParameters GeneralizedPlaneStrainReferenceResidual::validParams ( )

static

Definition at line 23 of file GeneralizedPlaneStrainReferenceResidual.C.

 {
   InputParameters params = AuxScalarKernel::validParams();
   params.addClassDescription("Generalized Plane Strain Reference Residual Scalar Kernel");
   params.addRequiredParam<UserObjectName>("generalized_plane_strain",
                                           "The name of the GeneralizedPlaneStrainUserObject");
   params.addParam<unsigned int>(
       "scalar_out_of_plane_strain_index",
       "The index number of scalar_out_of_plane_strain this kernel acts on");
  
   return params;
 }