#include <CavityPressureUserObject.h>

Inheritance diagram for CavityPressureUserObject:

Public Member Functions
	CavityPressureUserObject (const InputParameters &parameters)

virtual void	execute () override

virtual void	initialize () override

virtual void	finalize () override

virtual Real	computeCavityVolume ()

Real	getValue (const MooseEnum &quantity) const

Static Public Member Functions
static InputParameters	validParams ()

Protected Types
enum	CAVITY_PRESSURE_USEROBJECT_QUANTITY { INITIAL_MOLES, CAVITY_PRESSURE }

Protected Attributes
Real &	_cavity_pressure

Real &	_n0
	Initial number of moles of gas. More...

const Real	_initial_pressure

std::vector< const PostprocessorValue * >	_material_input

std::vector< const PostprocessorValue * >	_volume

const Real	_R

const Real &	_temperature

const bool	_init_temp_given

const Real	_init_temp

const Real	_startup_time

bool &	_initialized

Real	_start_time

Detailed Description

Definition at line 14 of file CavityPressureUserObject.h.

Member Enumeration Documentation

◆ CAVITY_PRESSURE_USEROBJECT_QUANTITY

enum CavityPressureUserObject::CAVITY_PRESSURE_USEROBJECT_QUANTITY

protected

Enumerator
INITIAL_MOLES
CAVITY_PRESSURE

Definition at line 30 of file CavityPressureUserObject.h.

   {
     INITIAL_MOLES,
     CAVITY_PRESSURE
   };

Constructor & Destructor Documentation

◆ CavityPressureUserObject()

CavityPressureUserObject::CavityPressureUserObject ( const InputParameters & parameters )

Definition at line 48 of file CavityPressureUserObject.C.

   : GeneralUserObject(params),
     _cavity_pressure(declareRestartableData<Real>("cavity_pressure", 0.0)),
     _n0(declareRestartableData<Real>("initial_moles", 0.0)),
     _initial_pressure(getParam<Real>("initial_pressure")),
     _material_input(params.get<std::vector<PostprocessorName>>("material_input").size()),
     _volume(params.get<std::vector<PostprocessorName>>("volume").size()),
     _R(getParam<Real>("R")),
     _temperature(getPostprocessorValue("temperature")),
     _init_temp_given(isParamValid("initial_temperature")),
     _init_temp(_init_temp_given ? getParam<Real>("initial_temperature") : 0.0),
     _startup_time(getParam<Real>("startup_time")),
     _initialized(declareRestartableData<bool>("initialized", false)),
     _start_time(0.0)
 {
   auto material_names = params.get<std::vector<PostprocessorName>>("material_input");
   for (unsigned int i = 0; i < _material_input.size(); ++i)
     _material_input[i] = &getPostprocessorValueByName(material_names[i]);
  
   auto volume_names = params.get<std::vector<PostprocessorName>>("volume");
   for (unsigned int i = 0; i < volume_names.size(); ++i)
     _volume[i] = &getPostprocessorValueByName(volume_names[i]);
 }

Member Function Documentation

◆ computeCavityVolume()

Real CavityPressureUserObject::computeCavityVolume ( )

virtual

Definition at line 131 of file CavityPressureUserObject.C.

 {
   Real volume = 0;
   for (unsigned int i = 0; i < _volume.size(); ++i)
     volume += *_volume[i];
  
   return volume;
 }

Referenced by execute(), and initialize().

◆ execute()

void CavityPressureUserObject::execute ( )

overridevirtual

Definition at line 117 of file CavityPressureUserObject.C.

 {
   const Real volume = computeCavityVolume();
   Real mat = 0;
  
   for (unsigned int i = 0; i < _material_input.size(); ++i)
     mat += *_material_input[i];
  
   const Real pressure = (_n0 + mat) * _R * _temperature / volume;
   const Real factor = _t >= _start_time + _startup_time ? 1.0 : (_t - _start_time) / _startup_time;
   _cavity_pressure = factor * pressure;
 }

◆ finalize()

virtual void CavityPressureUserObject::finalize ( )

inlineoverridevirtual

Definition at line 23 of file CavityPressureUserObject.h.

23 {}

◆ getValue()

Real CavityPressureUserObject::getValue ( const MooseEnum & quantity ) const

Definition at line 73 of file CavityPressureUserObject.C.

 {
   Real value = 0;
   if (quantity == INITIAL_MOLES)
   {
     if (_n0 < 0.0)
       mooseError("In ",
                  _name,
                  ": Negative number of moles calculated as an input for the cavity pressure");
  
     value = _n0;
   }
   else if (quantity == CAVITY_PRESSURE)
     value = _cavity_pressure;
   else
     mooseError("In ", _name, ": Unknown quantity.");
  
   return value;
 }

Referenced by CavityPressurePostprocessor::getValue().

◆ initialize()

void CavityPressureUserObject::initialize ( )

overridevirtual

Definition at line 94 of file CavityPressureUserObject.C.

 {
   if (!_initialized)
   {
     const Real volume = computeCavityVolume();
     Real init_temp = _temperature;
     if (_init_temp_given)
       init_temp = _init_temp;
  
     if (MooseUtils::absoluteFuzzyLessEqual(init_temp, 0.0))
       mooseError("Cannot have initial temperature of zero when initializing cavity pressure. "
                  "Does the supplied Postprocessor for temperature execute at initial?");
  
     _n0 = _initial_pressure * volume / (_R * init_temp);
     _start_time = _t - _dt;
     const Real factor =
         _t >= _start_time + _startup_time ? 1.0 : (_t - _start_time) / _startup_time;
     _cavity_pressure = factor * _initial_pressure;
     _initialized = true;
   }
 }

◆ validParams()

InputParameters CavityPressureUserObject::validParams ( )

static

Definition at line 17 of file CavityPressureUserObject.C.

 {
   InputParameters params = GeneralUserObject::validParams();
   params.addClassDescription("Uses the ideal gas law to compute internal pressure "
                              "and an initial moles of gas quantity.");
   params.addRangeCheckedParam<Real>(
       "initial_pressure",
       0.0,
       "initial_pressure >= 0.0",
       "The initial pressure in the cavity.  If not given, a zero initial pressure will be used.");
   params.addParam<std::vector<PostprocessorName>>("material_input",
                                                   "The name of the postprocessor(s) that holds the "
                                                   "amount of material injected into the cavity.");
   params.addRequiredRangeCheckedParam<Real>(
       "R", "R > 0.0", "The universal gas constant for the units used.");
   params.addRequiredParam<PostprocessorName>(
       "temperature", "The name of the average temperature postprocessor value.");
   params.addRangeCheckedParam<Real>(
       "initial_temperature", "initial_temperature > 0.0", "Initial temperature (optional)");
   params.addRequiredParam<std::vector<PostprocessorName>>(
       "volume",
       "The name of the postprocessor(s) that holds the value of the internal volume in the cavity");
   params.addParam<Real>(
       "startup_time",
       0.0,
       "The amount of time during which the pressure will ramp from zero to its true value.");
   params.set<bool>("use_displaced_mesh") = true;
  
   return params;
 }

Referenced by CavityPressureUOAction::validParams().

Member Data Documentation

◆ _cavity_pressure

Real& CavityPressureUserObject::_cavity_pressure

protected

Definition at line 36 of file CavityPressureUserObject.h.

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

◆ _init_temp

const Real CavityPressureUserObject::_init_temp

protected

Definition at line 50 of file CavityPressureUserObject.h.

Referenced by initialize().

◆ _init_temp_given

const bool CavityPressureUserObject::_init_temp_given

protected

Definition at line 49 of file CavityPressureUserObject.h.

Referenced by initialize().

◆ _initial_pressure

const Real CavityPressureUserObject::_initial_pressure

protected

Definition at line 41 of file CavityPressureUserObject.h.

Referenced by initialize().

◆ _initialized

bool& CavityPressureUserObject::_initialized

protected

Definition at line 54 of file CavityPressureUserObject.h.

Referenced by initialize().

◆ _material_input

std::vector<const PostprocessorValue *> CavityPressureUserObject::_material_input

protected

Definition at line 43 of file CavityPressureUserObject.h.

Referenced by CavityPressureUserObject(), and execute().

◆ _n0

Real& CavityPressureUserObject::_n0

protected

Initial number of moles of gas.

Definition at line 39 of file CavityPressureUserObject.h.

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

◆ _R

const Real CavityPressureUserObject::_R

protected

Definition at line 46 of file CavityPressureUserObject.h.

Referenced by execute(), and initialize().

◆ _start_time

Real CavityPressureUserObject::_start_time

protected

Definition at line 55 of file CavityPressureUserObject.h.

Referenced by execute(), and initialize().

◆ _startup_time

const Real CavityPressureUserObject::_startup_time

protected

Definition at line 52 of file CavityPressureUserObject.h.

Referenced by execute(), and initialize().

◆ _temperature

const Real& CavityPressureUserObject::_temperature

protected

Definition at line 48 of file CavityPressureUserObject.h.

Referenced by execute(), and initialize().

◆ _volume

std::vector<const PostprocessorValue *> CavityPressureUserObject::_volume

protected

Definition at line 44 of file CavityPressureUserObject.h.

Referenced by CavityPressureUserObject(), and computeCavityVolume().

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

tensor_mechanics/include/userobjects/CavityPressureUserObject.h
tensor_mechanics/src/userobjects/CavityPressureUserObject.C

Public Member Functions

Static Public Member Functions

Protected Types

Protected Attributes

Detailed Description

Member Enumeration Documentation

◆ CAVITY_PRESSURE_USEROBJECT_QUANTITY

Constructor & Destructor Documentation

◆ CavityPressureUserObject()

Member Function Documentation

◆ computeCavityVolume()

◆ execute()

◆ finalize()

◆ getValue()

◆ initialize()

◆ validParams()

Member Data Documentation

◆ _cavity_pressure

◆ _init_temp

◆ _init_temp_given

◆ _initial_pressure

◆ _initialized

◆ _material_input

◆ _n0

◆ _R

◆ _start_time

◆ _startup_time

◆ _temperature

◆ _volume