PressureTempl< is_ad > Class Template Reference

Pressure applies a pressure on a given boundary in the direction defined by component. More...

#include <Pressure.h>

Inheritance diagram for PressureTempl< is_ad >:

Public Member Functions
	PressureTempl (const InputParameters &parameters)

Static Public Member Functions
static InputParameters	validParams ()
static InputParameters	actionParams ()

Protected Member Functions
GenericReal< is_ad >	computePressure () const override

Protected Attributes
const Real	_alpha
	_alpha Parameter for HHT time integration scheme
	usingTransientInterfaceMembers
const Real	_factor
	Pressure value constant factor, function factor, and postprocessor factor.
const Function *const	_function
const PostprocessorValue *const	_postprocessor

Detailed Description

template<bool is_ad>
class PressureTempl< is_ad >

Pressure applies a pressure on a given boundary in the direction defined by component.

Definition at line 26 of file Pressure.h.

Constructor & Destructor Documentation

PressureTempl()

template<bool is_ad>

PressureTempl< is_ad >::PressureTempl

(

const InputParameters &

parameters

)

Definition at line 53 of file Pressure.C.

  : PressureParent<is_ad>(parameters),
    _factor(parameters.isParamSetByUser("factor")     ? this->template getParam<Real>("factor")
            : parameters.isParamSetByUser("constant") ? this->template getParam<Real>("constant")
                                                      : 1.0),
    _function(this->isParamValid("function") ? &this->getFunction("function") : NULL),
    _postprocessor(
        this->isParamValid("postprocessor") ? &this->getPostprocessorValue("postprocessor") : NULL),
    _alpha(this->template getParam<Real>("hht_alpha"))
{
  if (parameters.isParamSetByUser("factor") && parameters.isParamSetByUser("constant"))
    mooseError("Cannot set 'factor' and 'constant'.");
}

Member Function Documentation

actionParams()

template<bool is_ad>

InputParameters PressureTempl< is_ad >::actionParams ( )

static

Definition at line 34 of file Pressure.C.

{
  InputParameters params = PressureParent<is_ad>::actionParams();
  params.addDeprecatedParam<Real>("constant",
                                  "The magnitude to use in computing the pressure",
                                  "Use 'factor' in place of 'constant'");
  params.addParam<Real>("factor", 1.0, "The magnitude to use in computing the pressure");
  params.addParam<FunctionName>("function", "The function that describes the pressure");
  params.addParam<PostprocessorName>("postprocessor",
                                     "Postprocessor that will supply the pressure value");
 
  params.addParam<Real>("hht_alpha",
                        0,
                        "alpha parameter for mass dependent numerical damping induced "
                        "by HHT time integration scheme");
  return params;
}

computePressure()

template<bool is_ad>

GenericReal< is_ad > PressureTempl< is_ad >::computePressure ( ) const

overrideprotected

Definition at line 69 of file Pressure.C.

{
  GenericReal<is_ad> factor = _factor;
 
  if (_function)
    factor *= _function->value(_t + _alpha * _dt, _q_point[_qp]);
 
  if (_postprocessor)
    factor *= *_postprocessor;
 
  return factor;
}

validParams()

template<bool is_ad>

InputParameters PressureTempl< is_ad >::validParams ( )

static

Definition at line 24 of file Pressure.C.

{
  InputParameters params = PressureParent<is_ad>::validParams();
  params.addClassDescription("Applies a pressure on a given boundary in a given direction");
  params += actionParams();
  return params;
}

Member Data Documentation

_alpha

template<bool is_ad>

const Real PressureTempl< is_ad >::_alpha

protected

_alpha Parameter for HHT time integration scheme

Definition at line 44 of file Pressure.h.

_factor

template<bool is_ad>

const Real PressureTempl< is_ad >::_factor

protected

Pressure value constant factor, function factor, and postprocessor factor.

Definition at line 38 of file Pressure.h.

_function

template<bool is_ad>

const Function* const PressureTempl< is_ad >::_function

protected

Definition at line 39 of file Pressure.h.

_postprocessor

template<bool is_ad>

const PostprocessorValue* const PressureTempl< is_ad >::_postprocessor

protected

Definition at line 40 of file Pressure.h.

usingTransientInterfaceMembers

template<bool is_ad>

PressureTempl< is_ad >::usingTransientInterfaceMembers

protected

Definition at line 46 of file Pressure.h.

---

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

• solid_mechanics/include/bcs/Pressure.h
• solid_mechanics/src/bcs/Pressure.C