CrackDataSampler Class Reference

CrackDataSampler is a type of VectorPostprocessor that outputs the values of domain integrals, printed along with positions and angles along the crack front. More...

#include <CrackDataSampler.h>

Inheritance diagram for CrackDataSampler:

Public Member Functions
	CrackDataSampler (const InputParameters &parameters)
	Class constructor. More...
virtual	~CrackDataSampler ()
	Destructor. More...
virtual void	initialize ()
	Initialize, clears the postprocessor vector. More...
virtual void	execute ()
	Populates the postprocessor vector of values with the supplied postprocessors. More...
virtual void	finalize ()

Static Public Member Functions
static InputParameters	validParams ()

Protected Attributes
const CrackFrontDefinition *const	_crack_front_definition
MooseEnum	_position_type
std::vector< const PostprocessorValue * >	_domain_integral_postprocessor_values
	The vector of PostprocessorValue objects that are used to get the values of the domain integral postprocessors. More...

Detailed Description

CrackDataSampler is a type of VectorPostprocessor that outputs the values of domain integrals, printed along with positions and angles along the crack front.

Definition at line 27 of file CrackDataSampler.h.

Constructor & Destructor Documentation

CrackDataSampler()

CrackDataSampler::CrackDataSampler

(

const InputParameters &

parameters

)

Class constructor.

Parameters

parameters

The input parameters

Definition at line 41 of file CrackDataSampler.C.

  : GeneralVectorPostprocessor(parameters),
    SamplerBase(parameters, this, _communicator),
    _crack_front_definition(&getUserObject<CrackFrontDefinition>("crack_front_definition")),
    _position_type(getParam<MooseEnum>("position_type"))
{
  std::vector<PostprocessorName> pps_names(
      getParam<std::vector<PostprocessorName>>("postprocessors"));
  for (unsigned int i = 0; i < pps_names.size(); ++i)
  {
    if (!hasPostprocessorByName(pps_names[i]))
      mooseError("In CrackDataSampler, postprocessor with name: ", pps_names[i], " does not exist");
    _domain_integral_postprocessor_values.push_back(&getPostprocessorValueByName(pps_names[i]));
  }
  std::vector<std::string> var_names;
  var_names.push_back(name());
  SamplerBase::setupVariables(var_names);
}

~CrackDataSampler()

virtual CrackDataSampler::~CrackDataSampler ( )

inlinevirtual

Destructor.

Definition at line 41 of file CrackDataSampler.h.

{}

Member Function Documentation

execute()

void CrackDataSampler::execute ( )

virtual

Populates the postprocessor vector of values with the supplied postprocessors.

Definition at line 75 of file CrackDataSampler.C.

{
  if (processor_id() == 0)
  {
    std::vector<Real> values;
    for (unsigned int i = 0; i < _domain_integral_postprocessor_values.size(); ++i)
    {
      values.clear();
      const Point * crack_front_point = _crack_front_definition->getCrackFrontPoint(i);
      Real position;
      if (_position_type == "Angle")
        position = _crack_front_definition->getAngleAlongFront(i);
      else
        position = _crack_front_definition->getDistanceAlongFront(i);
 
      values.push_back(*_domain_integral_postprocessor_values[i]);
      addSample(*crack_front_point, position, values);
    }
  }
}

finalize()

void CrackDataSampler::finalize ( )

virtual

Definition at line 97 of file CrackDataSampler.C.

{
  SamplerBase::finalize();
}

initialize()

void CrackDataSampler::initialize ( )

virtual

Initialize, clears the postprocessor vector.

Definition at line 61 of file CrackDataSampler.C.

{
  if (_crack_front_definition->getNumCrackFrontPoints() !=
      _domain_integral_postprocessor_values.size())
    mooseError("In CrackDataSampler, number of crack front nodes != number of domain integral "
               "postprocessors");
  if (_position_type == "angle" && !_crack_front_definition->hasAngleAlongFront())
    mooseError(
        "In CrackDataSampler, 'position_type = Angle' specified, but angle is not available.  ",
        "Must specify 'crack_mouth_boundary' in CrackFrontDefinition");
  SamplerBase::initialize();
}

validParams()

InputParameters CrackDataSampler::validParams ( )

static

Definition at line 19 of file CrackDataSampler.C.

{
  InputParameters params = GeneralVectorPostprocessor::validParams();
 
  params += SamplerBase::validParams();
 
  params.addRequiredParam<std::vector<PostprocessorName>>(
      "postprocessors", "The postprocessors whose values are to be reported");
  params.addRequiredParam<UserObjectName>("crack_front_definition",
                                          "The CrackFrontDefinition user object name");
  MooseEnum position_type("Angle Distance", "Distance");
  params.addParam<MooseEnum>(
      "position_type",
      position_type,
      "The method used to calculate position along crack front.  Options are: " +
          position_type.getRawNames());
  params.addClassDescription("Outputs the values of a set of domain integral postprocessors as a "
                             "vector, along with their positions along the crack front.");
 
  return params;
}

Member Data Documentation

_crack_front_definition

const CrackFrontDefinition* const CrackDataSampler::_crack_front_definition

protected

Definition at line 56 of file CrackDataSampler.h.

Referenced by execute(), and initialize().

_domain_integral_postprocessor_values

std::vector<const PostprocessorValue *> CrackDataSampler::_domain_integral_postprocessor_values

protected

The vector of PostprocessorValue objects that are used to get the values of the domain integral postprocessors.

Definition at line 61 of file CrackDataSampler.h.

Referenced by CrackDataSampler(), execute(), and initialize().

_position_type

MooseEnum CrackDataSampler::_position_type

protected

Definition at line 58 of file CrackDataSampler.h.

Referenced by execute(), and initialize().

---

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

• tensor_mechanics/include/vectorpostprocessors/CrackDataSampler.h
• tensor_mechanics/src/vectorpostprocessors/CrackDataSampler.C