#include <GeneralizedPlaneStrain.h>

Inheritance diagram for GeneralizedPlaneStrain:

Public Member Functions
	GeneralizedPlaneStrain (const InputParameters &parameters)

virtual void	reinit ()

virtual void	computeResidual ()

virtual void	computeJacobian ()
	method to provide the diagonal jacobian term for scalar variable using value returned from Postprocessor, off diagonal terms are computed by computeOffDiagJacobianScalar in the kernel of nonlinear variables which needs to couple with the scalar variable More...

Static Public Member Functions
static InputParameters	validParams ()

Public Attributes
const GeneralizedPlaneStrainUserObject &	_gps

const unsigned int	_scalar_var_id

std::set< TagID >	_ref_tag_id
	The reference vector tag ID. More...

std::set< TagID >	_non_ref_tags
	The non-reference vector tag IDs. More...

Detailed Description

Definition at line 23 of file GeneralizedPlaneStrain.h.

Constructor & Destructor Documentation

◆ GeneralizedPlaneStrain()

GeneralizedPlaneStrain::GeneralizedPlaneStrain ( const InputParameters & parameters )

Definition at line 40 of file GeneralizedPlaneStrain.C.

   : ScalarKernel(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)
 {
   auto fe_problem_base = getCheckedPointerParam<FEProblemBase *>("_fe_problem_base");
   if (auto ref_resid_problem = dynamic_cast<ReferenceResidualProblem *>(fe_problem_base))
   {
     const auto & ref_parameters = ref_resid_problem->parameters();
     if (isParamValid("extra_vector_tags") && ref_parameters.isParamValid("reference_vector"))
     {
       const auto & reference_vector_tag_name = ref_parameters.get<TagName>("reference_vector");
       const auto & extra_vector_tag_names = getParam<std::vector<TagName>>("extra_vector_tags");
       if (std::find(extra_vector_tag_names.begin(),
                     extra_vector_tag_names.end(),
                     reference_vector_tag_name) != extra_vector_tag_names.end())
       {
         _ref_tag_id.insert(_subproblem.getVectorTagID(reference_vector_tag_name));
         std::set_difference(_vector_tags.begin(),
                             _vector_tags.end(),
                             _ref_tag_id.begin(),
                             _ref_tag_id.end(),
                             std::inserter(_non_ref_tags, _non_ref_tags.begin()));
       }
     }
   }
 }

Member Function Documentation

◆ computeJacobian()

void GeneralizedPlaneStrain::computeJacobian ( )

virtual

method to provide the diagonal jacobian term for scalar variable using value returned from Postprocessor, off diagonal terms are computed by computeOffDiagJacobianScalar in the kernel of nonlinear variables which needs to couple with the scalar variable

Definition at line 100 of file GeneralizedPlaneStrain.C.

 {
   prepareMatrixTag(_assembly, _var.number(), _var.number());
   for (_i = 0; _i < _local_ke.m(); ++_i)
     _local_ke(_i, _i) += _gps.returnJacobian(_scalar_var_id);
  
   accumulateTaggedLocalMatrix();
 }

◆ computeResidual()

void GeneralizedPlaneStrain::computeResidual ( )

virtual

Definition at line 71 of file GeneralizedPlaneStrain.C.

 {
   if (!_ref_tag_id.empty())
     _vector_tags = _non_ref_tags;
  
   prepareVectorTag(_assembly, _var.number());
   for (_i = 0; _i < _local_re.size(); ++_i)
     _local_re(_i) += _gps.returnResidual(_scalar_var_id);
  
   accumulateTaggedLocalResidual();
  
   if (!_ref_tag_id.empty())
   {
     _vector_tags = _ref_tag_id;
  
     prepareVectorTag(_assembly, _var.number());
     for (_i = 0; _i < _local_re.size(); ++_i)
       _local_re(_i) += _gps.returnReferenceResidual(_scalar_var_id);
  
     accumulateTaggedLocalResidual();
   }
 }

◆ reinit()

virtual void GeneralizedPlaneStrain::reinit ( )

inlinevirtual

Definition at line 30 of file GeneralizedPlaneStrain.h.

30 {};

◆ validParams()

InputParameters GeneralizedPlaneStrain::validParams ( )

static

Definition at line 27 of file GeneralizedPlaneStrain.C.

 {
   InputParameters params = ScalarKernel::validParams();
   params.addClassDescription("Generalized Plane Strain 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;
 }

Member Data Documentation

◆ _gps

const GeneralizedPlaneStrainUserObject& GeneralizedPlaneStrain::_gps

Definition at line 34 of file GeneralizedPlaneStrain.h.

Referenced by computeJacobian(), and computeResidual().

◆ _non_ref_tags

std::set<TagID> GeneralizedPlaneStrain::_non_ref_tags

The non-reference vector tag IDs.

Definition at line 41 of file GeneralizedPlaneStrain.h.

Referenced by computeResidual(), and GeneralizedPlaneStrain().

◆ _ref_tag_id

std::set<TagID> GeneralizedPlaneStrain::_ref_tag_id

The reference vector tag ID.

Definition at line 38 of file GeneralizedPlaneStrain.h.

Referenced by computeResidual(), and GeneralizedPlaneStrain().

◆ _scalar_var_id

const unsigned int GeneralizedPlaneStrain::_scalar_var_id

Definition at line 35 of file GeneralizedPlaneStrain.h.