https://mooseframework.inl.gov
Public Types | Public Member Functions | Static Public Member Functions | Public Attributes | Protected Member Functions | Protected Attributes | List of all members
GeneralizedPlaneStrainReferenceResidual Class Reference

#include <GeneralizedPlaneStrainReferenceResidual.h>

Inheritance diagram for GeneralizedPlaneStrainReferenceResidual:
[legend]

Public Types

typedef DataFileName DataFileParameterType
 

Public Member Functions

 GeneralizedPlaneStrainReferenceResidual (const InputParameters &parameters)
 
virtual Real computeValue () override
 
virtual void compute ()
 
MooseVariableScalar & variable ()
 
SubProblem & subProblem ()
 
virtual const std::set< std::string > & getRequestedItems () override
 
virtual const std::set< std::string > & getSuppliedItems () override
 
virtual bool isActive ()
 
virtual bool enabled () const
 
std::shared_ptr< MooseObject > getSharedPtr ()
 
std::shared_ptr< const MooseObject > getSharedPtr () const
 
MooseApp & getMooseApp () const
 
const std::string & type () const
 
virtual const std::string & name () const
 
std::string typeAndName () const
 
std::string errorPrefix (const std::string &error_type) const
 
void callMooseError (std::string msg, const bool with_prefix) const
 
MooseObjectParameterName uniqueParameterName (const std::string &parameter_name) const
 
const InputParameters & parameters () const
 
MooseObjectName uniqueName () const
 
const T & getParam (const std::string &name) const
 
std::vector< std::pair< T1, T2 > > getParam (const std::string &param1, const std::string &param2) const
 
const T * queryParam (const std::string &name) const
 
const T & getRenamedParam (const std::string &old_name, const std::string &new_name) const
 
T getCheckedPointerParam (const std::string &name, const std::string &error_string="") const
 
bool isParamValid (const std::string &name) const
 
bool isParamSetByUser (const std::string &nm) const
 
void paramError (const std::string &param, Args... args) const
 
void paramWarning (const std::string &param, Args... args) const
 
void paramInfo (const std::string &param, Args... args) const
 
void connectControllableParams (const std::string &parameter, const std::string &object_type, const std::string &object_name, const std::string &object_parameter) const
 
void mooseError (Args &&... args) const
 
void mooseErrorNonPrefixed (Args &&... args) const
 
void mooseDocumentedError (const std::string &repo_name, const unsigned int issue_num, Args &&... args) const
 
void mooseWarning (Args &&... args) const
 
void mooseWarningNonPrefixed (Args &&... args) const
 
void mooseDeprecated (Args &&... args) const
 
void mooseInfo (Args &&... args) const
 
std::string getDataFileName (const std::string &param) const
 
std::string getDataFileNameByName (const std::string &relative_path) const
 
std::string getDataFilePath (const std::string &relative_path) const
 
const std::vector< MooseVariableScalar *> & getCoupledMooseScalarVars ()
 
const std::set< TagID > & getScalarVariableCoupleableVectorTags () const
 
const std::set< TagID > & getScalarVariableCoupleableMatrixTags () const
 
virtual void initialSetup ()
 
virtual void timestepSetup ()
 
virtual void jacobianSetup ()
 
virtual void residualSetup ()
 
virtual void subdomainSetup ()
 
virtual void customSetup (const ExecFlagType &)
 
const ExecFlagEnum & getExecuteOnEnum () const
 
const Function & getFunction (const std::string &name) const
 
const Function & getFunctionByName (const FunctionName &name) const
 
bool hasFunction (const std::string &param_name) const
 
bool hasFunctionByName (const FunctionName &name) const
 
UserObjectName getUserObjectName (const std::string &param_name) const
 
const T & getUserObject (const std::string &param_name, bool is_dependency=true) const
 
const T & getUserObjectByName (const UserObjectName &object_name, bool is_dependency=true) const
 
const UserObject & getUserObjectBase (const std::string &param_name, bool is_dependency=true) const
 
const UserObject & getUserObjectBaseByName (const UserObjectName &object_name, bool is_dependency=true) const
 
bool isDefaultPostprocessorValue (const std::string &param_name, const unsigned int index=0) const
 
bool hasPostprocessor (const std::string &param_name, const unsigned int index=0) const
 
bool hasPostprocessorByName (const PostprocessorName &name) const
 
std::size_t coupledPostprocessors (const std::string &param_name) const
 
const PostprocessorName & getPostprocessorName (const std::string &param_name, const unsigned int index=0) const
 
bool isImplicit ()
 
Moose::StateArg determineState () const
 
virtual void meshChanged ()
 
bool hasUserObject (const std::string &param_name) const
 
bool hasUserObject (const std::string &param_name) const
 
bool hasUserObject (const std::string &param_name) const
 
bool hasUserObject (const std::string &param_name) const
 
bool hasUserObjectByName (const UserObjectName &object_name) const
 
bool hasUserObjectByName (const UserObjectName &object_name) const
 
bool hasUserObjectByName (const UserObjectName &object_name) const
 
bool hasUserObjectByName (const UserObjectName &object_name) const
 
const PostprocessorValue & getPostprocessorValue (const std::string &param_name, const unsigned int index=0) const
 
const PostprocessorValue & getPostprocessorValue (const std::string &param_name, const unsigned int index=0) const
 
const PostprocessorValue & getPostprocessorValueOld (const std::string &param_name, const unsigned int index=0) const
 
const PostprocessorValue & getPostprocessorValueOld (const std::string &param_name, const unsigned int index=0) const
 
const PostprocessorValue & getPostprocessorValueOlder (const std::string &param_name, const unsigned int index=0) const
 
const PostprocessorValue & getPostprocessorValueOlder (const std::string &param_name, const unsigned int index=0) const
 
virtual const PostprocessorValue & getPostprocessorValueByName (const PostprocessorName &name) const
 
virtual const PostprocessorValue & getPostprocessorValueByName (const PostprocessorName &name) const
 
const PostprocessorValue & getPostprocessorValueOldByName (const PostprocessorName &name) const
 
const PostprocessorValue & getPostprocessorValueOldByName (const PostprocessorName &name) const
 
const PostprocessorValue & getPostprocessorValueOlderByName (const PostprocessorName &name) const
 
const PostprocessorValue & getPostprocessorValueOlderByName (const PostprocessorName &name) const
 
const Parallel::Communicator & comm () const
 
processor_id_type n_processors () const
 
processor_id_type processor_id () const
 

Static Public Member Functions

static InputParameters validParams ()
 
static void sort (typename std::vector< T > &vector)
 
static void sortDFS (typename std::vector< T > &vector)
 
static void cyclicDependencyError (CyclicDependencyException< T2 > &e, const std::string &header)
 

Public Attributes

const GeneralizedPlaneStrainUserObject & _gps
 
const unsigned int _scalar_var_id
 
const ConsoleStream _console
 

Protected Member Functions

const VariableValue & uOld () const
 
bool isCoupledScalar (const std::string &var_name, unsigned int i=0) const
 
unsigned int coupledScalarComponents (const std::string &var_name) const
 
unsigned int coupledScalar (const std::string &var_name, unsigned int comp=0) const
 
libMesh::Order coupledScalarOrder (const std::string &var_name, unsigned int comp=0) const
 
const VariableValue & coupledScalarValue (const std::string &var_name, unsigned int comp=0) const
 
const ADVariableValue & adCoupledScalarValue (const std::string &var_name, unsigned int comp=0) const
 
const GenericVariableValue< is_ad > & coupledGenericScalarValue (const std::string &var_name, unsigned int comp=0) const
 
const GenericVariableValue< false > & coupledGenericScalarValue (const std::string &var_name, const unsigned int comp) const
 
const GenericVariableValue< true > & coupledGenericScalarValue (const std::string &var_name, const unsigned int comp) const
 
const VariableValue & coupledVectorTagScalarValue (const std::string &var_name, TagID tag, unsigned int comp=0) const
 
const VariableValue & coupledMatrixTagScalarValue (const std::string &var_name, TagID tag, unsigned int comp=0) const
 
const VariableValue & coupledScalarValueOld (const std::string &var_name, unsigned int comp=0) const
 
const VariableValue & coupledScalarValueOlder (const std::string &var_name, unsigned int comp=0) const
 
const VariableValue & coupledScalarDot (const std::string &var_name, unsigned int comp=0) const
 
const ADVariableValue & adCoupledScalarDot (const std::string &var_name, unsigned int comp=0) const
 
const VariableValue & coupledScalarDotDot (const std::string &var_name, unsigned int comp=0) const
 
const VariableValue & coupledScalarDotOld (const std::string &var_name, unsigned int comp=0) const
 
const VariableValue & coupledScalarDotDotOld (const std::string &var_name, unsigned int comp=0) const
 
const VariableValue & coupledScalarDotDu (const std::string &var_name, unsigned int comp=0) const
 
const VariableValue & coupledScalarDotDotDu (const std::string &var_name, unsigned int comp=0) const
 
const MooseVariableScalar * getScalarVar (const std::string &var_name, unsigned int comp) const
 
virtual void addUserObjectDependencyHelper (const UserObject &) const
 
virtual void addPostprocessorDependencyHelper (const PostprocessorName &) const
 

Protected Attributes

SubProblem & _subproblem
 
SystemBase & _sys
 
THREAD_ID _tid
 
Assembly & _assembly
 
MooseVariableScalar & _var
 
MooseMesh & _mesh
 
unsigned int _i
 
const VariableValue & _u
 
std::set< std::string > _depend_vars
 
std::set< std::string > _supplied_vars
 
const bool & _enabled
 
MooseApp & _app
 
const std::string _type
 
const std::string _name
 
const InputParameters & _pars
 
Factory & _factory
 
ActionFactory & _action_factory
 
FEProblemBase & _sc_fe_problem
 
const THREAD_ID _sc_tid
 
const Real & _real_zero
 
const VariableValue & _scalar_zero
 
const Point & _point_zero
 
const ExecFlagEnum & _execute_enum
 
const ExecFlagType & _current_execute_flag
 
const InputParameters & _ti_params
 
FEProblemBase & _ti_feproblem
 
bool _is_implicit
 
Real & _t
 
const Real & _t_old
 
int & _t_step
 
Real & _dt
 
Real & _dt_old
 
bool _is_transient
 
FEProblemBase & _mci_feproblem
 
const Parallel::Communicator & _communicator
 

Detailed Description

Definition at line 17 of file GeneralizedPlaneStrainReferenceResidual.h.

Constructor & Destructor Documentation

◆ GeneralizedPlaneStrainReferenceResidual()

GeneralizedPlaneStrainReferenceResidual::GeneralizedPlaneStrainReferenceResidual ( const InputParameters &  parameters)

Definition at line 34 of file GeneralizedPlaneStrainReferenceResidual.C.

36  : AuxScalarKernel(parameters),
37  _gps(getUserObject<GeneralizedPlaneStrainUserObject>("generalized_plane_strain")),
38  _scalar_var_id(isParamValid("scalar_out_of_plane_strain_index")
39  ? getParam<unsigned int>("scalar_out_of_plane_strain_index")
40  : 0)
41 {
42 }
AuxScalarKernel::isParamValid
bool isParamValid(const std::string &name) const
AuxScalarKernel::parameters
const InputParameters & parameters() const
AuxScalarKernel::AuxScalarKernel
AuxScalarKernel(const InputParameters &parameters)

Member Function Documentation

◆ computeValue()

Real GeneralizedPlaneStrainReferenceResidual::computeValue ( )
overridevirtual

Implements AuxScalarKernel.

Definition at line 45 of file GeneralizedPlaneStrainReferenceResidual.C.

46 {
47  return _gps.returnReferenceResidual(_scalar_var_id);
48 }
GeneralizedPlaneStrainUserObject::returnReferenceResidual
virtual Real returnReferenceResidual(unsigned int scalar_var_id=0) const override
Definition: GeneralizedPlaneStrainUserObject.C:164

◆ validParams()

InputParameters GeneralizedPlaneStrainReferenceResidual::validParams ( )
static

Definition at line 21 of file GeneralizedPlaneStrainReferenceResidual.C.

22 {
23  InputParameters params = AuxScalarKernel::validParams();
24  params.addClassDescription("Generalized Plane Strain Reference Residual Scalar Kernel");
25  params.addRequiredParam<UserObjectName>("generalized_plane_strain",
26  "The name of the GeneralizedPlaneStrainUserObject");
27  params.addParam<unsigned int>(
28  "scalar_out_of_plane_strain_index",
29  "The index number of scalar_out_of_plane_strain this kernel acts on");
30 
31  return params;
32 }
InputParameters::addParam
void addParam(const std::string &name, const std::initializer_list< typename T::value_type > &value, const std::string &doc_string)
InputParameters::addRequiredParam
void addRequiredParam(const std::string &name, const std::string &doc_string)
AuxScalarKernel::validParams
static InputParameters validParams()
InputParameters::addClassDescription
void addClassDescription(const std::string &doc_string)

Member Data Documentation

◆ _gps

const GeneralizedPlaneStrainUserObject& GeneralizedPlaneStrainReferenceResidual::_gps

Definition at line 26 of file GeneralizedPlaneStrainReferenceResidual.h.

Referenced by computeValue().

◆ _scalar_var_id

const unsigned int GeneralizedPlaneStrainReferenceResidual::_scalar_var_id

Definition at line 27 of file GeneralizedPlaneStrainReferenceResidual.h.

Referenced by computeValue().

The documentation for this class was generated from the following files:
Generated on Fri Jul 18 2025 13:47:13 for https://mooseframework.inl.gov by   doxygen 1.8.14