GlobalDisplacementAux Class Reference

#include <GlobalDisplacementAux.h>

Inheritance diagram for GlobalDisplacementAux:

Public Member Functions
	GlobalDisplacementAux (const InputParameters &parameters)
virtual Real	computeValue () override

Static Public Member Functions
static InputParameters	validParams ()

Protected Attributes
const VariableValue &	_scalar_global_strain
const unsigned int	_component
bool	_output_global_disp
const GlobalStrainUserObjectInterface &	_pst
const VectorValue< bool > &	_periodic_dir
const Point	_ref_point
const unsigned int	_dim
const unsigned int	_ndisp
std::vector< const VariableValue * >	_disp

Detailed Description

Definition at line 24 of file GlobalDisplacementAux.h.

Constructor & Destructor Documentation

GlobalDisplacementAux()

GlobalDisplacementAux::GlobalDisplacementAux

(

const InputParameters &

parameters

)

Definition at line 48 of file GlobalDisplacementAux.C.

  : AuxKernel(parameters),
    _scalar_global_strain(coupledScalarValue("scalar_global_strain")),
    _component(getParam<unsigned int>("component")),
    _output_global_disp(getParam<bool>("output_global_displacement")),
    _pst(getUserObject<GlobalStrainUserObjectInterface>("global_strain_uo")),
    _periodic_dir(_pst.getPeriodicDirections()),
    _ref_point(parameters.get<Point>("reference_point")),
    _dim(_mesh.dimension()),
    _ndisp(coupledComponents("displacements")),
    _disp(_ndisp)
{
  if (!isNodal())
    paramError("variable", "GlobalDisplacementAux must be used on a nodal auxiliary variable");
 
  if (_component >= _dim)
    paramError("component",
               "The component ",
               _component,
               " does not exist for ",
               _dim,
               " dimensional problems");
 
  for (unsigned int i = 0; i < _ndisp; ++i)
    _disp[i] = &coupledValue("displacements", i);
}

Member Function Documentation

computeValue()

Real GlobalDisplacementAux::computeValue ( )

overridevirtual

Definition at line 76 of file GlobalDisplacementAux.C.

{
  RankTwoTensor strain;
  strain.fillFromScalarVariable(_scalar_global_strain);
 
  for (unsigned int dir = 0; dir < _dim; ++dir)
    if (!_periodic_dir(dir))
      for (unsigned int var = 0; var < _ndisp; ++var)
        strain(dir, var) = 0.0;
 
  const RealVectorValue & global_disp = strain * ((*_current_node) - _ref_point);
 
  if (_output_global_disp)
    return global_disp(_component);
  else
    return global_disp(_component) + (*_disp[_component])[_qp];
}

validParams()

InputParameters GlobalDisplacementAux::validParams ( )

static

Definition at line 23 of file GlobalDisplacementAux.C.

{
  InputParameters params = AuxKernel::validParams();
  params.addClassDescription(
      "AuxKernel to visualize the displacements generated by the global strain tensor");
  params.addCoupledVar("scalar_global_strain",
                       "Scalar variable providing global strain components");
  params.addCoupledVar("displacements", "The name of the displacement variables");
  params.addRequiredParam<unsigned int>("component",
                                        "The displacement component to consider for this kernel");
  params.addParam<bool>(
      "output_global_displacement", false, "Option to output global displacement only");
  params.addRequiredParam<UserObjectName>("global_strain_uo",
                                          "The name of the GlobalStrainUserObject");
  params.addParam<Point>("reference_point",
                         Point(0, 0, 0),
                         "The coordinate of the center/fixed point of the simulation");
 
  // Default this object to get executed before the displaced mesh update.
  // This way the AuxVars set by this object can be used as mesh displacements.
  params.set<ExecFlagEnum>("execute_on") = EXEC_PRE_DISPLACE;
 
  return params;
}

Member Data Documentation

_component

const unsigned int GlobalDisplacementAux::_component

protected

Definition at line 35 of file GlobalDisplacementAux.h.

Referenced by computeValue(), and GlobalDisplacementAux().

_dim

const unsigned int GlobalDisplacementAux::_dim

protected

Definition at line 43 of file GlobalDisplacementAux.h.

Referenced by computeValue(), and GlobalDisplacementAux().

_disp

std::vector<const VariableValue *> GlobalDisplacementAux::_disp

protected

Definition at line 45 of file GlobalDisplacementAux.h.

Referenced by computeValue(), and GlobalDisplacementAux().

_ndisp

const unsigned int GlobalDisplacementAux::_ndisp

protected

Definition at line 44 of file GlobalDisplacementAux.h.

Referenced by computeValue(), and GlobalDisplacementAux().

_output_global_disp

bool GlobalDisplacementAux::_output_global_disp

protected

Definition at line 37 of file GlobalDisplacementAux.h.

Referenced by computeValue().

_periodic_dir

const VectorValue<bool>& GlobalDisplacementAux::_periodic_dir

protected

Definition at line 40 of file GlobalDisplacementAux.h.

Referenced by computeValue().

_pst

const GlobalStrainUserObjectInterface& GlobalDisplacementAux::_pst

protected

Definition at line 39 of file GlobalDisplacementAux.h.

_ref_point

const Point GlobalDisplacementAux::_ref_point

protected

Definition at line 41 of file GlobalDisplacementAux.h.

Referenced by computeValue().

_scalar_global_strain

const VariableValue& GlobalDisplacementAux::_scalar_global_strain

protected

Definition at line 34 of file GlobalDisplacementAux.h.

Referenced by computeValue().

---

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

• tensor_mechanics/include/auxkernels/GlobalDisplacementAux.h
• tensor_mechanics/src/auxkernels/GlobalDisplacementAux.C