https://mooseframework.inl.gov
Public Types | Public Member Functions | Static Public Member Functions | Public Attributes | Static Public Attributes | Protected Member Functions | Protected Attributes | Static Protected Attributes | Private Member Functions | Private Attributes | List of all members
ADRayKernelTempl< T > Class Template Referenceabstract

Base class for an AD ray kernel that contributes to the residual and/or Jacobian. More...

#include <ADRayKernel.h>

Inheritance diagram for ADRayKernelTempl< T >:
[legend]

Public Types

typedef DataFileName DataFileParameterType
 
enum  ResidualTagType { ResidualTagType::NonReference, ResidualTagType::Reference }
 

Public Member Functions

 ADRayKernelTempl (const InputParameters &params)
 
MooseVariableField< T > & variable ()
 The MooseVariable this RayKernel contributes to. More...
 
void onSegment () override final
 Called on each segment of a Ray. More...
 
virtual void preExecuteStudy () override
 Insertion point called immediately before executing the RayTracingStudy. More...
 
virtual void preTrace ()
 Called at the beginning of the trace on this processor/thread for a Ray. More...
 
virtual void postTrace ()
 This method is called once a ray has reached the end of its trace. More...
 
bool needSegmentReinit () const
 Whether or not this RayKernel needs a segment reinit. More...
 
const std::set< std::string > & getRequestedItems () override
 
const std::set< std::string > & getSuppliedItems () override
 
RayTracingStudystudy ()
 The RayTracingStudy associated with this object. More...
 
const RayTracingStudystudy () const
 The RayTracingStudy associated with this object. More...
 
template<typename T >
T & getStudy ()
 Casts the RayTracingStudy associated with this object to a study of type T with a meaningful error message if it fails. More...
 
virtual void postExecuteStudy ()
 Insertion point called immediately after executing the RayTracingStudy. More...
 
virtual bool enabled () const
 
std::shared_ptr< MooseObjectgetSharedPtr ()
 
std::shared_ptr< const MooseObjectgetSharedPtr () const
 
MooseAppgetMooseApp () 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 InputParametersparameters () 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
 
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 Parallel::Communicator & comm () const
 
processor_id_type n_processors () const
 
processor_id_type processor_id () const
 
virtual void initialSetup ()
 
virtual void timestepSetup ()
 
virtual void jacobianSetup ()
 
virtual void residualSetup ()
 
virtual void subdomainSetup ()
 
virtual void customSetup (const ExecFlagType &)
 
const ExecFlagEnumgetExecuteOnEnum () const
 
const FunctiongetFunction (const std::string &name) const
 
const FunctiongetFunctionByName (const FunctionName &name) const
 
bool hasFunction (const std::string &param_name) const
 
bool hasFunctionByName (const FunctionName &name) 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
 
const PostprocessorValuegetPostprocessorValue (const std::string &param_name, const unsigned int index=0) const
 
const PostprocessorValuegetPostprocessorValue (const std::string &param_name, const unsigned int index=0) const
 
const PostprocessorValuegetPostprocessorValueOld (const std::string &param_name, const unsigned int index=0) const
 
const PostprocessorValuegetPostprocessorValueOld (const std::string &param_name, const unsigned int index=0) const
 
const PostprocessorValuegetPostprocessorValueOlder (const std::string &param_name, const unsigned int index=0) const
 
const PostprocessorValuegetPostprocessorValueOlder (const std::string &param_name, const unsigned int index=0) const
 
virtual const PostprocessorValuegetPostprocessorValueByName (const PostprocessorName &name) const
 
virtual const PostprocessorValuegetPostprocessorValueByName (const PostprocessorName &name) const
 
const PostprocessorValuegetPostprocessorValueOldByName (const PostprocessorName &name) const
 
const PostprocessorValuegetPostprocessorValueOldByName (const PostprocessorName &name) const
 
const PostprocessorValuegetPostprocessorValueOlderByName (const PostprocessorName &name) const
 
const PostprocessorValuegetPostprocessorValueOlderByName (const PostprocessorName &name) const
 
const VectorPostprocessorValuegetVectorPostprocessorValue (const std::string &param_name, const std::string &vector_name) const
 
const VectorPostprocessorValuegetVectorPostprocessorValue (const std::string &param_name, const std::string &vector_name, bool needs_broadcast) const
 
const VectorPostprocessorValuegetVectorPostprocessorValueByName (const VectorPostprocessorName &name, const std::string &vector_name) const
 
const VectorPostprocessorValuegetVectorPostprocessorValueByName (const VectorPostprocessorName &name, const std::string &vector_name, bool needs_broadcast) const
 
const VectorPostprocessorValuegetVectorPostprocessorValueOld (const std::string &param_name, const std::string &vector_name) const
 
const VectorPostprocessorValuegetVectorPostprocessorValueOld (const std::string &param_name, const std::string &vector_name, bool needs_broadcast) const
 
const VectorPostprocessorValuegetVectorPostprocessorValueOldByName (const VectorPostprocessorName &name, const std::string &vector_name) const
 
const VectorPostprocessorValuegetVectorPostprocessorValueOldByName (const VectorPostprocessorName &name, const std::string &vector_name, bool needs_broadcast) const
 
const ScatterVectorPostprocessorValuegetScatterVectorPostprocessorValue (const std::string &param_name, const std::string &vector_name) const
 
const ScatterVectorPostprocessorValuegetScatterVectorPostprocessorValueByName (const VectorPostprocessorName &name, const std::string &vector_name) const
 
const ScatterVectorPostprocessorValuegetScatterVectorPostprocessorValueOld (const std::string &param_name, const std::string &vector_name) const
 
const ScatterVectorPostprocessorValuegetScatterVectorPostprocessorValueOldByName (const VectorPostprocessorName &name, const std::string &vector_name) const
 
bool hasVectorPostprocessor (const std::string &param_name, const std::string &vector_name) const
 
bool hasVectorPostprocessor (const std::string &param_name) const
 
bool hasVectorPostprocessorByName (const VectorPostprocessorName &name, const std::string &vector_name) const
 
bool hasVectorPostprocessorByName (const VectorPostprocessorName &name) const
 
const VectorPostprocessorName & getVectorPostprocessorName (const std::string &param_name) const
 
bool isVectorPostprocessorDistributed (const std::string &param_name) const
 
bool isVectorPostprocessorDistributed (const std::string &param_name) const
 
bool isVectorPostprocessorDistributedByName (const VectorPostprocessorName &name) const
 
bool isVectorPostprocessorDistributedByName (const VectorPostprocessorName &name) const
 
virtual void meshChanged ()
 
bool isImplicit ()
 
Moose::StateArg determineState () 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 UserObjectgetUserObjectBase (const std::string &param_name, bool is_dependency=true) const
 
const UserObjectgetUserObjectBaseByName (const UserObjectName &object_name, bool is_dependency=true) 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 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
 
virtual const VariableValuecoupledValueByName (const std::string &var_name)
 
virtual const ArrayVariableValuecoupledArrayValueByName (const std::string &var_name)
 
const std::unordered_map< std::string, std::vector< MooseVariableFieldBase *> > & getCoupledVars () const
 
const std::vector< MooseVariableFieldBase *> & getCoupledMooseVars () const
 
const std::vector< MooseVariable *> & getCoupledStandardMooseVars () const
 
const std::vector< VectorMooseVariable *> & getCoupledVectorMooseVars () const
 
const std::vector< ArrayMooseVariable *> & getCoupledArrayMooseVars () const
 
void addFEVariableCoupleableVectorTag (TagID tag)
 
void addFEVariableCoupleableMatrixTag (TagID tag)
 
std::set< TagID > & getFEVariableCoupleableVectorTags ()
 
const std::set< TagID > & getFEVariableCoupleableVectorTags () const
 
std::set< TagID > & getFEVariableCoupleableMatrixTags ()
 
const std::set< TagID > & getFEVariableCoupleableMatrixTags () const
 
auto & getWritableCoupledVariables () const
 
bool hasWritableCoupledVariables () const
 
const ADVariableValuegetADDefaultValue (const std::string &var_name) const
 
const ADVectorVariableValuegetADDefaultVectorValue (const std::string &var_name) const
 
const ADVariableGradientgetADDefaultGradient () const
 
const ADVectorVariableGradientgetADDefaultVectorGradient () const
 
const ADVariableSecondgetADDefaultSecond () const
 
const ADVectorVariableCurlgetADDefaultCurl () const
 
const std::vector< MooseVariableScalar *> & getCoupledMooseScalarVars ()
 
const std::set< TagID > & getScalarVariableCoupleableVectorTags () const
 
const std::set< TagID > & getScalarVariableCoupleableMatrixTags () const
 
const std::set< MooseVariableFieldBase *> & getMooseVariableDependencies () const
 
std::set< MooseVariableFieldBase *> checkAllVariables (const DofObjectType &dof_object, const std::set< MooseVariableFieldBase * > &vars_to_omit={})
 
std::set< MooseVariableFieldBase *> checkVariables (const DofObjectType &dof_object, const std::set< MooseVariableFieldBase * > &vars_to_check)
 
void addMooseVariableDependency (MooseVariableFieldBase *var)
 
void addMooseVariableDependency (const std::vector< MooseVariableFieldBase * > &vars)
 
const std::vector< SubdomainName > & blocks () const
 
unsigned int numBlocks () const
 
virtual const std::set< SubdomainID > & blockIDs () const
 
unsigned int blocksMaxDimension () const
 
bool hasBlocks (const SubdomainName &name) const
 
bool hasBlocks (const std::vector< SubdomainName > &names) const
 
bool hasBlocks (const std::set< SubdomainName > &names) const
 
bool hasBlocks (SubdomainID id) const
 
bool hasBlocks (const std::vector< SubdomainID > &ids) const
 
bool hasBlocks (const std::set< SubdomainID > &ids) const
 
bool isBlockSubset (const std::set< SubdomainID > &ids) const
 
bool isBlockSubset (const std::vector< SubdomainID > &ids) const
 
bool hasBlockMaterialProperty (const std::string &prop_name)
 
const std::set< SubdomainID > & meshBlockIDs () const
 
virtual bool blockRestricted () const
 
virtual void checkVariable (const MooseVariableFieldBase &variable) const
 
void setRandomResetFrequency (ExecFlagType exec_flag)
 
unsigned long getRandomLong () const
 
Real getRandomReal () const
 
unsigned int getSeed (std::size_t id)
 
unsigned int getMasterSeed () const
 
bool isNodal () const
 
ExecFlagType getResetOnTime () const
 
void setRandomDataPointer (RandomData *random_data)
 
std::pair< const MaterialProperty< T > *, std::set< SubdomainID > > getBlockMaterialProperty (const MaterialPropertyName &name)
 
const GenericMaterialProperty< T, is_ad > & getGenericZeroMaterialProperty (const std::string &name)
 
const GenericMaterialProperty< T, is_ad > & getGenericZeroMaterialProperty ()
 
const GenericMaterialProperty< T, is_ad > & getGenericZeroMaterialPropertyByName (const std::string &prop_name)
 
const MaterialProperty< T > & getZeroMaterialProperty (Ts... args)
 
std::set< SubdomainIDgetMaterialPropertyBlocks (const std::string &name)
 
std::vector< SubdomainName > getMaterialPropertyBlockNames (const std::string &name)
 
std::set< BoundaryIDgetMaterialPropertyBoundaryIDs (const std::string &name)
 
std::vector< BoundaryName > getMaterialPropertyBoundaryNames (const std::string &name)
 
void checkBlockAndBoundaryCompatibility (std::shared_ptr< MaterialBase > discrete)
 
std::unordered_map< SubdomainID, std::vector< MaterialBase *> > buildRequiredMaterials (bool allow_stateful=true)
 
void statefulPropertiesAllowed (bool)
 
bool getMaterialPropertyCalled () const
 
virtual const std::unordered_set< unsigned int > & getMatPropDependencies () const
 
virtual void resolveOptionalProperties ()
 
const GenericMaterialProperty< T, is_ad > & getGenericMaterialProperty (const std::string &name, MaterialData &material_data, const unsigned int state=0)
 
const GenericMaterialProperty< T, is_ad > & getGenericMaterialProperty (const std::string &name, const unsigned int state=0)
 
const GenericMaterialProperty< T, is_ad > & getGenericMaterialProperty (const std::string &name, const unsigned int state=0)
 
const MaterialProperty< T > & getMaterialProperty (const std::string &name, MaterialData &material_data, const unsigned int state=0)
 
const MaterialProperty< T > & getMaterialProperty (const std::string &name, const unsigned int state=0)
 
const MaterialProperty< T > & getMaterialProperty (const std::string &name, const unsigned int state=0)
 
const ADMaterialProperty< T > & getADMaterialProperty (const std::string &name, MaterialData &material_data)
 
const ADMaterialProperty< T > & getADMaterialProperty (const std::string &name)
 
const ADMaterialProperty< T > & getADMaterialProperty (const std::string &name)
 
const GenericMaterialProperty< T, is_ad > & getGenericMaterialPropertyByName (const MaterialPropertyName &name, MaterialData &material_data, const unsigned int state)
 
const GenericMaterialProperty< T, is_ad > & getGenericMaterialPropertyByName (const MaterialPropertyName &name, const unsigned int state=0)
 
const GenericMaterialProperty< T, is_ad > & getGenericMaterialPropertyByName (const MaterialPropertyName &name, const unsigned int state=0)
 
const GenericMaterialProperty< T, is_ad > & getPossiblyConstantGenericMaterialPropertyByName (const MaterialPropertyName &prop_name, MaterialData &material_data, const unsigned int state)
 
const MaterialProperty< T > & getMaterialPropertyByName (const MaterialPropertyName &name, MaterialData &material_data, const unsigned int state=0)
 
const MaterialProperty< T > & getMaterialPropertyByName (const MaterialPropertyName &name, const unsigned int state=0)
 
const MaterialProperty< T > & getMaterialPropertyByName (const MaterialPropertyName &name, const unsigned int state=0)
 
const ADMaterialProperty< T > & getADMaterialPropertyByName (const MaterialPropertyName &name, MaterialData &material_data)
 
const ADMaterialProperty< T > & getADMaterialPropertyByName (const MaterialPropertyName &name)
 
const ADMaterialProperty< T > & getADMaterialPropertyByName (const MaterialPropertyName &name)
 
const MaterialProperty< T > & getMaterialPropertyOld (const std::string &name, MaterialData &material_data)
 
const MaterialProperty< T > & getMaterialPropertyOld (const std::string &name)
 
const MaterialProperty< T > & getMaterialPropertyOld (const std::string &name)
 
const MaterialProperty< T > & getMaterialPropertyOlder (const std::string &name, MaterialData &material_data)
 
const MaterialProperty< T > & getMaterialPropertyOlder (const std::string &name)
 
const MaterialProperty< T > & getMaterialPropertyOlder (const std::string &name)
 
const MaterialProperty< T > & getMaterialPropertyOldByName (const MaterialPropertyName &name, MaterialData &material_data)
 
const MaterialProperty< T > & getMaterialPropertyOldByName (const MaterialPropertyName &name)
 
const MaterialProperty< T > & getMaterialPropertyOldByName (const MaterialPropertyName &name)
 
const MaterialProperty< T > & getMaterialPropertyOlderByName (const MaterialPropertyName &name, MaterialData &material_data)
 
const MaterialProperty< T > & getMaterialPropertyOlderByName (const MaterialPropertyName &name)
 
const MaterialProperty< T > & getMaterialPropertyOlderByName (const MaterialPropertyName &name)
 
const GenericOptionalMaterialProperty< T, is_ad > & getGenericOptionalMaterialProperty (const std::string &name, const unsigned int state=0)
 
const GenericOptionalMaterialProperty< T, is_ad > & getGenericOptionalMaterialProperty (const std::string &name, const unsigned int state=0)
 
const OptionalMaterialProperty< T > & getOptionalMaterialProperty (const std::string &name, const unsigned int state=0)
 
const OptionalMaterialProperty< T > & getOptionalMaterialProperty (const std::string &name, const unsigned int state=0)
 
const OptionalADMaterialProperty< T > & getOptionalADMaterialProperty (const std::string &name)
 
const OptionalADMaterialProperty< T > & getOptionalADMaterialProperty (const std::string &name)
 
const OptionalMaterialProperty< T > & getOptionalMaterialPropertyOld (const std::string &name)
 
const OptionalMaterialProperty< T > & getOptionalMaterialPropertyOld (const std::string &name)
 
const OptionalMaterialProperty< T > & getOptionalMaterialPropertyOlder (const std::string &name)
 
const OptionalMaterialProperty< T > & getOptionalMaterialPropertyOlder (const std::string &name)
 
MaterialBasegetMaterial (const std::string &name)
 
MaterialBasegetMaterial (const std::string &name)
 
MaterialBasegetMaterialByName (const std::string &name, bool no_warn=false)
 
MaterialBasegetMaterialByName (const std::string &name, bool no_warn=false)
 
bool hasMaterialProperty (const std::string &name)
 
bool hasMaterialProperty (const std::string &name)
 
bool hasMaterialPropertyByName (const std::string &name)
 
bool hasMaterialPropertyByName (const std::string &name)
 
bool hasADMaterialProperty (const std::string &name)
 
bool hasADMaterialProperty (const std::string &name)
 
bool hasADMaterialPropertyByName (const std::string &name)
 
bool hasADMaterialPropertyByName (const std::string &name)
 
bool hasGenericMaterialProperty (const std::string &name)
 
bool hasGenericMaterialProperty (const std::string &name)
 
bool hasGenericMaterialPropertyByName (const std::string &name)
 
bool hasGenericMaterialPropertyByName (const std::string &name)
 
MooseVariableBasemooseVariableBase () const
 
MooseVariableField< T > & mooseVariableField ()
 
MooseVariableFE< T > * mooseVariable () const
 
MooseVariableFV< T > * mooseVariableFV () const
 
MooseLinearVariableFV< T > * mooseLinearVariableFV () const
 
void useVectorTag (const TagName &tag_name, VectorTagsKey)
 
void useVectorTag (TagID tag_id, VectorTagsKey)
 
void useMatrixTag (const TagName &tag_name, MatrixTagsKey)
 
void useMatrixTag (TagID tag_id, MatrixTagsKey)
 
bool isVectorTagged ()
 
bool isMatrixTagged ()
 
bool hasVectorTags () const
 
const std::set< TagID > & getVectorTags (VectorTagsKey) const
 
const std::set< TagID > & getMatrixTags (MatrixTagsKey) 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 ConsoleStream _console
 

Static Public Attributes

static constexpr PropertyValue::id_type default_property_id
 
static constexpr PropertyValue::id_type zero_property_id
 

Protected Member Functions

virtual ADReal computeQpResidual ()=0
 Compute this kernel's contribution to the residual at _qp and _i. More...
 
virtual void precalculateResidual ()
 Insertion point for calculation before the residual computation. More...
 
void changeRayStartDirection (const Point &start, const Point &direction)
 Changes the current Ray's start point and direction. More...
 
std::shared_ptr< RayacquireRay (const Point &start, const Point &direction)
 Acquires a Ray to be used for generating a new Ray while tracing on the boundary. More...
 
void moveRayToBuffer (std::shared_ptr< Ray > &ray)
 Moves a Ray into the working buffer to be traced during tracing with a meaningful error on verification failure. More...
 
const std::shared_ptr< Ray > & currentRay () const
 Gets the current Ray that this is working on. More...
 
void dependsOn (const std::string name)
 Add an object of this classes base type that this class depends on. More...
 
NonlinearSystemBasegetNonlinearSystem ()
 Get the right nonlinear system. More...
 
virtual void addPostprocessorDependencyHelper (const PostprocessorName &) const
 
virtual void addVectorPostprocessorDependencyHelper (const VectorPostprocessorName &) const
 
virtual void addUserObjectDependencyHelper (const UserObject &) const
 
virtual void coupledCallback (const std::string &, bool) const
 
virtual bool isCoupled (const std::string &var_name, unsigned int i=0) const
 
virtual bool isCoupledConstant (const std::string &var_name) const
 
unsigned int coupledComponents (const std::string &var_name) const
 
VariableName coupledName (const std::string &var_name, unsigned int comp=0) const
 
std::vector< VariableName > coupledNames (const std::string &var_name) const
 
virtual unsigned int coupled (const std::string &var_name, unsigned int comp=0) const
 
std::vector< unsigned intcoupledIndices (const std::string &var_name) const
 
virtual const VariableValuecoupledValue (const std::string &var_name, unsigned int comp=0) const
 
std::vector< const VariableValue *> coupledValues (const std::string &var_name) const
 
std::vector< const VectorVariableValue *> coupledVectorValues (const std::string &var_name) const
 
const GenericVariableValue< is_ad > & coupledGenericValue (const std::string &var_name, unsigned int comp=0) const
 
const GenericVariableValue< false > & coupledGenericValue (const std::string &var_name, unsigned int comp) const
 
const GenericVariableValue< true > & coupledGenericValue (const std::string &var_name, unsigned int comp) const
 
const GenericVectorVariableValue< is_ad > & coupledGenericVectorValue (const std::string &var_name, unsigned int comp=0) const
 
const GenericVectorVariableValue< false > & coupledGenericVectorValue (const std::string &var_name, unsigned int comp) const
 
const GenericVectorVariableValue< true > & coupledGenericVectorValue (const std::string &var_name, unsigned int comp) const
 
std::vector< const GenericVariableValue< is_ad > *> coupledGenericValues (const std::string &var_name) const
 
std::vector< const GenericVariableValue< false > *> coupledGenericValues (const std::string &var_name) const
 
std::vector< const GenericVariableValue< true > *> coupledGenericValues (const std::string &var_name) const
 
const GenericVariableValue< is_ad > & coupledGenericDofValue (const std::string &var_name, unsigned int comp=0) const
 
const GenericVariableValue< false > & coupledGenericDofValue (const std::string &var_name, unsigned int comp) const
 
const GenericVariableValue< true > & coupledGenericDofValue (const std::string &var_name, unsigned int comp) const
 
const GenericVariableValue< is_ad > & coupledGenericDot (const std::string &var_name, unsigned int comp=0) const
 
const GenericVariableValue< false > & coupledGenericDot (const std::string &var_name, unsigned int comp) const
 
const GenericVariableValue< true > & coupledGenericDot (const std::string &var_name, unsigned int comp) const
 
const GenericVariableValue< is_ad > & coupledGenericDotDot (const std::string &var_name, unsigned int comp=0) const
 
const GenericVariableValue< false > & coupledGenericDotDot (const std::string &var_name, unsigned int comp) const
 
const GenericVariableValue< true > & coupledGenericDotDot (const std::string &var_name, unsigned int comp) const
 
virtual const VariableValuecoupledValueLower (const std::string &var_name, unsigned int comp=0) const
 
const ADVariableValueadCoupledValue (const std::string &var_name, unsigned int comp=0) const
 
std::vector< const ADVariableValue *> adCoupledValues (const std::string &var_name) const
 
const ADVariableValueadCoupledLowerValue (const std::string &var_name, unsigned int comp=0) const
 
const ADVectorVariableValueadCoupledVectorValue (const std::string &var_name, unsigned int comp=0) const
 
std::vector< const ADVectorVariableValue *> adCoupledVectorValues (const std::string &var_name) const
 
virtual const VariableValuecoupledVectorTagValue (const std::string &var_names, TagID tag, unsigned int index=0) const
 
virtual const VariableValuecoupledVectorTagValue (const std::string &var_names, const std::string &tag_name, unsigned int index=0) const
 
std::vector< const VariableValue *> coupledVectorTagValues (const std::string &var_names, TagID tag) const
 
std::vector< const VariableValue *> coupledVectorTagValues (const std::string &var_names, const std::string &tag_name) const
 
virtual const ArrayVariableValuecoupledVectorTagArrayValue (const std::string &var_names, TagID tag, unsigned int index=0) const
 
virtual const ArrayVariableValuecoupledVectorTagArrayValue (const std::string &var_names, const std::string &tag_name, unsigned int index=0) const
 
std::vector< const ArrayVariableValue *> coupledVectorTagArrayValues (const std::string &var_names, TagID tag) const
 
std::vector< const ArrayVariableValue *> coupledVectorTagArrayValues (const std::string &var_names, const std::string &tag_name) const
 
virtual const VariableGradientcoupledVectorTagGradient (const std::string &var_names, TagID tag, unsigned int index=0) const
 
virtual const VariableGradientcoupledVectorTagGradient (const std::string &var_names, const std::string &tag_name, unsigned int index=0) const
 
std::vector< const VariableGradient *> coupledVectorTagGradients (const std::string &var_names, TagID tag) const
 
std::vector< const VariableGradient *> coupledVectorTagGradients (const std::string &var_names, const std::string &tag_name) const
 
virtual const ArrayVariableGradientcoupledVectorTagArrayGradient (const std::string &var_names, TagID tag, unsigned int index=0) const
 
virtual const ArrayVariableGradientcoupledVectorTagArrayGradient (const std::string &var_names, const std::string &tag_name, unsigned int index=0) const
 
std::vector< const ArrayVariableGradient *> coupledVectorTagArrayGradients (const std::string &var_names, TagID tag) const
 
std::vector< const ArrayVariableGradient *> coupledVectorTagArrayGradients (const std::string &var_names, const std::string &tag_name) const
 
virtual const VariableValuecoupledVectorTagDofValue (const std::string &var_name, TagID tag, unsigned int index=0) const
 
virtual const VariableValuecoupledVectorTagDofValue (const std::string &var_names, const std::string &tag_name, unsigned int index=0) const
 
const ArrayVariableValuecoupledVectorTagArrayDofValue (const std::string &var_name, const std::string &tag_name, unsigned int comp=0) const
 
std::vector< const VariableValue *> coupledVectorTagDofValues (const std::string &var_names, TagID tag) const
 
std::vector< const VariableValue *> coupledVectorTagDofValues (const std::string &var_names, const std::string &tag_name) const
 
virtual const VariableValuecoupledMatrixTagValue (const std::string &var_names, TagID tag, unsigned int index=0) const
 
virtual const VariableValuecoupledMatrixTagValue (const std::string &var_names, const std::string &tag_name, unsigned int index=0) const
 
std::vector< const VariableValue *> coupledMatrixTagValues (const std::string &var_names, TagID tag) const
 
std::vector< const VariableValue *> coupledMatrixTagValues (const std::string &var_names, const std::string &tag_name) const
 
virtual const VectorVariableValuecoupledVectorValue (const std::string &var_name, unsigned int comp=0) const
 
virtual const ArrayVariableValuecoupledArrayValue (const std::string &var_name, unsigned int comp=0) const
 
std::vector< const ArrayVariableValue *> coupledArrayValues (const std::string &var_name) const
 
MooseWritableVariablewritableVariable (const std::string &var_name, unsigned int comp=0)
 
virtual VariableValuewritableCoupledValue (const std::string &var_name, unsigned int comp=0)
 
void checkWritableVar (MooseWritableVariable *var)
 
virtual const VariableValuecoupledValueOld (const std::string &var_name, unsigned int comp=0) const
 
std::vector< const VariableValue *> coupledValuesOld (const std::string &var_name) const
 
std::vector< const VectorVariableValue *> coupledVectorValuesOld (const std::string &var_name) const
 
virtual const VariableValuecoupledValueOlder (const std::string &var_name, unsigned int comp=0) const
 
std::vector< const VariableValue *> coupledValuesOlder (const std::string &var_name) const
 
virtual const VariableValuecoupledValuePreviousNL (const std::string &var_name, unsigned int comp=0) const
 
virtual const VectorVariableValuecoupledVectorValueOld (const std::string &var_name, unsigned int comp=0) const
 
virtual const VectorVariableValuecoupledVectorValueOlder (const std::string &var_name, unsigned int comp=0) const
 
virtual const ArrayVariableValuecoupledArrayValueOld (const std::string &var_name, unsigned int comp=0) const
 
virtual const ArrayVariableValuecoupledArrayValueOlder (const std::string &var_name, unsigned int comp=0) const
 
virtual const VariableGradientcoupledGradient (const std::string &var_name, unsigned int comp=0) const
 
std::vector< const VariableGradient *> coupledGradients (const std::string &var_name) const
 
const ADVariableGradientadCoupledGradient (const std::string &var_name, unsigned int comp=0) const
 
const ADVariableGradientadCoupledGradientDot (const std::string &var_name, unsigned int comp=0) const
 
std::vector< const ADVariableGradient *> adCoupledGradients (const std::string &var_name) const
 
const GenericVariableGradient< is_ad > & coupledGenericGradient (const std::string &var_name, unsigned int comp=0) const
 
const GenericVariableGradient< false > & coupledGenericGradient (const std::string &var_name, unsigned int comp) const
 
const GenericVariableGradient< true > & coupledGenericGradient (const std::string &var_name, unsigned int comp) const
 
std::vector< const GenericVariableGradient< is_ad > *> coupledGenericGradients (const std::string &var_name) const
 
std::vector< const GenericVariableGradient< false > *> coupledGenericGradients (const std::string &var_name) const
 
std::vector< const GenericVariableGradient< true > *> coupledGenericGradients (const std::string &var_name) const
 
const ADVectorVariableGradientadCoupledVectorGradient (const std::string &var_name, unsigned int comp=0) const
 
const ADVariableSecondadCoupledSecond (const std::string &var_name, unsigned int comp=0) const
 
const ADVectorVariableSecondadCoupledVectorSecond (const std::string &var_name, unsigned int comp=0) const
 
virtual const VariableGradientcoupledGradientOld (const std::string &var_name, unsigned int comp=0) const
 
std::vector< const VariableGradient *> coupledGradientsOld (const std::string &var_name) const
 
virtual const VariableGradientcoupledGradientOlder (const std::string &var_name, unsigned int comp=0) const
 
virtual const VariableGradientcoupledGradientPreviousNL (const std::string &var_name, unsigned int comp=0) const
 
virtual const VariableGradientcoupledGradientDot (const std::string &var_name, unsigned int comp=0) const
 
virtual const VariableGradientcoupledGradientDotDot (const std::string &var_name, unsigned int comp=0) const
 
virtual const VectorVariableGradientcoupledVectorGradient (const std::string &var_name, unsigned int comp=0) const
 
virtual const VectorVariableGradientcoupledVectorGradientOld (const std::string &var_name, unsigned int comp=0) const
 
virtual const VectorVariableGradientcoupledVectorGradientOlder (const std::string &var_name, unsigned int comp=0) const
 
virtual const ArrayVariableGradientcoupledArrayGradient (const std::string &var_name, unsigned int comp=0) const
 
virtual const ArrayVariableGradientcoupledArrayGradientOld (const std::string &var_name, unsigned int comp=0) const
 
virtual const ArrayVariableGradientcoupledArrayGradientOlder (const std::string &var_name, unsigned int comp=0) const
 
virtual const ArrayVariableGradientcoupledArrayGradientDot (const std::string &var_name, unsigned int comp=0) const
 
virtual const VectorVariableCurlcoupledCurl (const std::string &var_name, unsigned int comp=0) const
 
virtual const VectorVariableCurlcoupledCurlOld (const std::string &var_name, unsigned int comp=0) const
 
virtual const VectorVariableCurlcoupledCurlOlder (const std::string &var_name, unsigned int comp=0) const
 
const ADVectorVariableCurladCoupledCurl (const std::string &var_name, unsigned int comp=0) const
 
virtual const VectorVariableDivergencecoupledDiv (const std::string &var_name, unsigned int comp=0) const
 
virtual const VectorVariableDivergencecoupledDivOld (const std::string &var_name, unsigned int comp=0) const
 
virtual const VectorVariableDivergencecoupledDivOlder (const std::string &var_name, unsigned int comp=0) const
 
virtual const VariableSecondcoupledSecond (const std::string &var_name, unsigned int comp=0) const
 
virtual const VariableSecondcoupledSecondOld (const std::string &var_name, unsigned int comp=0) const
 
virtual const VariableSecondcoupledSecondOlder (const std::string &var_name, unsigned int comp=0) const
 
virtual const VariableSecondcoupledSecondPreviousNL (const std::string &var_name, unsigned int comp=0) const
 
virtual const VariableValuecoupledDot (const std::string &var_name, unsigned int comp=0) const
 
std::vector< const VariableValue *> coupledDots (const std::string &var_name) const
 
virtual const VariableValuecoupledDotDot (const std::string &var_name, unsigned int comp=0) const
 
virtual const VariableValuecoupledDotOld (const std::string &var_name, unsigned int comp=0) const
 
virtual const VariableValuecoupledDotDotOld (const std::string &var_name, unsigned int comp=0) const
 
const ADVariableValueadCoupledDot (const std::string &var_name, unsigned int comp=0) const
 
std::vector< const ADVariableValue *> adCoupledDots (const std::string &var_name) const
 
const ADVariableValueadCoupledDotDot (const std::string &var_name, unsigned int comp=0) const
 
const ADVectorVariableValueadCoupledVectorDot (const std::string &var_name, unsigned int comp=0) const
 
virtual const VectorVariableValuecoupledVectorDot (const std::string &var_name, unsigned int comp=0) const
 
virtual const VectorVariableValuecoupledVectorDotDot (const std::string &var_name, unsigned int comp=0) const
 
virtual const VectorVariableValuecoupledVectorDotOld (const std::string &var_name, unsigned int comp=0) const
 
virtual const VectorVariableValuecoupledVectorDotDotOld (const std::string &var_name, unsigned int comp=0) const
 
virtual const VariableValuecoupledVectorDotDu (const std::string &var_name, unsigned int comp=0) const
 
virtual const VariableValuecoupledVectorDotDotDu (const std::string &var_name, unsigned int comp=0) const
 
virtual const ArrayVariableValuecoupledArrayDot (const std::string &var_name, unsigned int comp=0) const
 
virtual const ArrayVariableValuecoupledArrayDotDot (const std::string &var_name, unsigned int comp=0) const
 
virtual const ArrayVariableValuecoupledArrayDotOld (const std::string &var_name, unsigned int comp=0) const
 
virtual const ArrayVariableValuecoupledArrayDotDotOld (const std::string &var_name, unsigned int comp=0) const
 
virtual const VariableValuecoupledDotDu (const std::string &var_name, unsigned int comp=0) const
 
virtual const VariableValuecoupledDotDotDu (const std::string &var_name, unsigned int comp=0) const
 
const VariableValuecoupledArrayDotDu (const std::string &var_name, unsigned int comp=0) const
 
const T & coupledNodalValue (const std::string &var_name, unsigned int comp=0) const
 
const Moose::ADType< T >::typeadCoupledNodalValue (const std::string &var_name, unsigned int comp=0) const
 
const T & coupledNodalValueOld (const std::string &var_name, unsigned int comp=0) const
 
const T & coupledNodalValueOlder (const std::string &var_name, unsigned int comp=0) const
 
const T & coupledNodalValuePreviousNL (const std::string &var_name, unsigned int comp=0) const
 
const T & coupledNodalDot (const std::string &var_name, unsigned int comp=0) const
 
virtual const VariableValuecoupledNodalDotDot (const std::string &var_name, unsigned int comp=0) const
 
virtual const VariableValuecoupledNodalDotOld (const std::string &var_name, unsigned int comp=0) const
 
virtual const VariableValuecoupledNodalDotDotOld (const std::string &var_name, unsigned int comp=0) const
 
virtual const VariableValuecoupledDofValues (const std::string &var_name, unsigned int comp=0) const
 
std::vector< const VariableValue *> coupledAllDofValues (const std::string &var_name) const
 
virtual const VariableValuecoupledDofValuesOld (const std::string &var_name, unsigned int comp=0) const
 
std::vector< const VariableValue *> coupledAllDofValuesOld (const std::string &var_name) const
 
virtual const VariableValuecoupledDofValuesOlder (const std::string &var_name, unsigned int comp=0) const
 
std::vector< const VariableValue *> coupledAllDofValuesOlder (const std::string &var_name) const
 
virtual const ArrayVariableValuecoupledArrayDofValues (const std::string &var_name, unsigned int comp=0) const
 
virtual const ADVariableValueadCoupledDofValues (const std::string &var_name, unsigned int comp=0) const
 
const ADVariableValueadZeroValue () const
 
const ADVariableGradientadZeroGradient () const
 
const ADVariableSecondadZeroSecond () const
 
const GenericVariableValue< is_ad > & genericZeroValue ()
 
const GenericVariableValue< false > & genericZeroValue ()
 
const GenericVariableValue< true > & genericZeroValue ()
 
const GenericVariableGradient< is_ad > & genericZeroGradient ()
 
const GenericVariableGradient< false > & genericZeroGradient ()
 
const GenericVariableGradient< true > & genericZeroGradient ()
 
const GenericVariableSecond< is_ad > & genericZeroSecond ()
 
const GenericVariableSecond< false > & genericZeroSecond ()
 
const GenericVariableSecond< true > & genericZeroSecond ()
 
bool checkVar (const std::string &var_name, unsigned int comp=0, unsigned int comp_bound=0) const
 
const MooseVariableFieldBasegetFEVar (const std::string &var_name, unsigned int comp) const
 
const MooseVariableFieldBasegetFieldVar (const std::string &var_name, unsigned int comp) const
 
MooseVariableFieldBasegetFieldVar (const std::string &var_name, unsigned int comp)
 
const T * getVarHelper (const std::string &var_name, unsigned int comp) const
 
T * getVarHelper (const std::string &var_name, unsigned int comp)
 
MooseVariablegetVar (const std::string &var_name, unsigned int comp)
 
const MooseVariablegetVar (const std::string &var_name, unsigned int comp) const
 
VectorMooseVariablegetVectorVar (const std::string &var_name, unsigned int comp)
 
const VectorMooseVariablegetVectorVar (const std::string &var_name, unsigned int comp) const
 
ArrayMooseVariablegetArrayVar (const std::string &var_name, unsigned int comp)
 
const ArrayMooseVariablegetArrayVar (const std::string &var_name, unsigned int comp) const
 
void validateExecutionerType (const std::string &name, const std::string &fn_name) const
 
std::vector< T > coupledVectorHelper (const std::string &var_name, const Func &func) 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 VariableValuecoupledScalarValue (const std::string &var_name, unsigned int comp=0) const
 
const ADVariableValueadCoupledScalarValue (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 VariableValuecoupledVectorTagScalarValue (const std::string &var_name, TagID tag, unsigned int comp=0) const
 
const VariableValuecoupledMatrixTagScalarValue (const std::string &var_name, TagID tag, unsigned int comp=0) const
 
const VariableValuecoupledScalarValueOld (const std::string &var_name, unsigned int comp=0) const
 
const VariableValuecoupledScalarValueOlder (const std::string &var_name, unsigned int comp=0) const
 
const VariableValuecoupledScalarDot (const std::string &var_name, unsigned int comp=0) const
 
const ADVariableValueadCoupledScalarDot (const std::string &var_name, unsigned int comp=0) const
 
const VariableValuecoupledScalarDotDot (const std::string &var_name, unsigned int comp=0) const
 
const VariableValuecoupledScalarDotOld (const std::string &var_name, unsigned int comp=0) const
 
const VariableValuecoupledScalarDotDotOld (const std::string &var_name, unsigned int comp=0) const
 
const VariableValuecoupledScalarDotDu (const std::string &var_name, unsigned int comp=0) const
 
const VariableValuecoupledScalarDotDotDu (const std::string &var_name, unsigned int comp=0) const
 
const MooseVariableScalargetScalarVar (const std::string &var_name, unsigned int comp) const
 
virtual bool hasBlockMaterialPropertyHelper (const std::string &prop_name)
 
void initializeBlockRestrictable (const MooseObject *moose_object)
 
Moose::CoordinateSystemType getBlockCoordSystem ()
 
virtual void checkMaterialProperty (const std::string &name, const unsigned int state)
 
void markMatPropRequested (const std::string &)
 
MaterialPropertyName getMaterialPropertyName (const std::string &name) const
 
void checkExecutionStage ()
 
const GenericMaterialProperty< T, is_ad > * defaultGenericMaterialProperty (const std::string &name)
 
const GenericMaterialProperty< T, is_ad > * defaultGenericMaterialProperty (const std::string &name)
 
const MaterialProperty< T > * defaultMaterialProperty (const std::string &name)
 
const MaterialProperty< T > * defaultMaterialProperty (const std::string &name)
 
const ADMaterialProperty< T > * defaultADMaterialProperty (const std::string &name)
 
const ADMaterialProperty< T > * defaultADMaterialProperty (const std::string &name)
 
T & declareRestartableData (const std::string &data_name, Args &&... args)
 
ManagedValue< T > declareManagedRestartableDataWithContext (const std::string &data_name, void *context, Args &&... args)
 
const T & getRestartableData (const std::string &data_name) const
 
T & declareRestartableDataWithContext (const std::string &data_name, void *context, Args &&... args)
 
T & declareRecoverableData (const std::string &data_name, Args &&... args)
 
T & declareRestartableDataWithObjectName (const std::string &data_name, const std::string &object_name, Args &&... args)
 
T & declareRestartableDataWithObjectNameWithContext (const std::string &data_name, const std::string &object_name, void *context, Args &&... args)
 
std::string restartableName (const std::string &data_name) const
 
virtual const OutputTools< T >::VariableValuevalue ()
 
virtual const OutputTools< T >::VariableValuevalueOld ()
 
virtual const OutputTools< T >::VariableValuevalueOlder ()
 
virtual const OutputTools< T >::VariableValuedot ()
 
virtual const OutputTools< T >::VariableValuedotDot ()
 
virtual const OutputTools< T >::VariableValuedotOld ()
 
virtual const OutputTools< T >::VariableValuedotDotOld ()
 
virtual const VariableValuedotDu ()
 
virtual const VariableValuedotDotDu ()
 
virtual const OutputTools< T >::VariableGradientgradient ()
 
virtual const OutputTools< T >::VariableGradientgradientOld ()
 
virtual const OutputTools< T >::VariableGradientgradientOlder ()
 
virtual const OutputTools< T >::VariableSecondsecond ()
 
virtual const OutputTools< T >::VariableSecondsecondOld ()
 
virtual const OutputTools< T >::VariableSecondsecondOlder ()
 
virtual const OutputTools< T >::VariableTestSecondsecondTest ()
 
virtual const OutputTools< T >::VariableTestSecondsecondTestFace ()
 
virtual const OutputTools< T >::VariablePhiSecondsecondPhi ()
 
virtual const OutputTools< T >::VariablePhiSecondsecondPhiFace ()
 
void prepareVectorTag (Assembly &assembly, unsigned int ivar)
 
void prepareVectorTag (Assembly &assembly, unsigned int ivar, ResidualTagType tag_type)
 
void prepareVectorTagNeighbor (Assembly &assembly, unsigned int ivar)
 
void prepareVectorTagLower (Assembly &assembly, unsigned int ivar)
 
void prepareMatrixTag (Assembly &assembly, unsigned int ivar, unsigned int jvar)
 
void prepareMatrixTag (Assembly &assembly, unsigned int ivar, unsigned int jvar, DenseMatrix< Number > &k) const
 
void prepareMatrixTagNonlocal (Assembly &assembly, unsigned int ivar, unsigned int jvar)
 
void prepareMatrixTagNeighbor (Assembly &assembly, unsigned int ivar, unsigned int jvar, Moose::DGJacobianType type)
 
void prepareMatrixTagNeighbor (Assembly &assembly, unsigned int ivar, unsigned int jvar, Moose::DGJacobianType type, DenseMatrix< Number > &k) const
 
void prepareMatrixTagLower (Assembly &assembly, unsigned int ivar, unsigned int jvar, Moose::ConstraintJacobianType type)
 
void accumulateTaggedLocalResidual ()
 
void assignTaggedLocalResidual ()
 
void accumulateTaggedLocalMatrix ()
 
void accumulateTaggedLocalMatrix (Assembly &assembly, unsigned int ivar, unsigned int jvar, const DenseMatrix< Number > &k)
 
void accumulateTaggedLocalMatrix (Assembly &assembly, unsigned int ivar, unsigned int jvar, Moose::DGJacobianType type, const DenseMatrix< Number > &k)
 
void accumulateTaggedNonlocalMatrix ()
 
void assignTaggedLocalMatrix ()
 
void addResiduals (Assembly &assembly, const Residuals &residuals, const Indices &dof_indices, Real scaling_factor)
 
void addResiduals (Assembly &assembly, const DenseVector< T > &residuals, const Indices &dof_indices, Real scaling_factor)
 
void addResiduals (Assembly &assembly, const ADResidualsPacket &packet)
 
void addResidualsAndJacobian (Assembly &assembly, const Residuals &residuals, const Indices &dof_indices, Real scaling_factor)
 
void addResidualsAndJacobian (Assembly &assembly, const ADResidualsPacket &packet)
 
void addJacobian (Assembly &assembly, const Residuals &residuals, const Indices &dof_indices, Real scaling_factor)
 
void addJacobian (Assembly &assembly, const ADResidualsPacket &packet)
 
void addJacobian (Assembly &assembly, DenseMatrix< Real > &local_k, const std::vector< dof_id_type > &row_indices, const std::vector< dof_id_type > &column_indices, Real scaling_factor)
 
void addResidualsWithoutConstraints (Assembly &assembly, const Residuals &residuals, const Indices &dof_indices, Real scaling_factor)
 
void addResidualsAndJacobianWithoutConstraints (Assembly &assembly, const Residuals &residuals, const Indices &dof_indices, Real scaling_factor)
 
void addJacobianWithoutConstraints (Assembly &assembly, const Residuals &residuals, const Indices &dof_indices, Real scaling_factor)
 
void addJacobianElement (Assembly &assembly, Real value, dof_id_type row_index, dof_id_type column_index, Real scaling_factor)
 
void setResidual (SystemBase &sys, const T &residual, MooseVariableFE< T > &var)
 
void setResidual (SystemBase &sys, Real residual, dof_id_type dof_index)
 
void setResidual (SystemBase &sys, SetResidualFunctor set_residual_functor)
 

Protected Attributes

MooseVariableField< T > & _var
 The MooseVariable this kernel contributes to. More...
 
const ADTemplateVariableTestValue< T > & _test
 The current test function. More...
 
const ADTemplateVariableValue< T > & _u
 Holds the solution at current quadrature points. More...
 
const ADTemplateVariableGradient< T > & _grad_u
 Holds the solution gradient at the current quadrature points. More...
 
const ADTemplateVariablePhiValue< T > & _phi
 The current shape functions. More...
 
unsigned int _i
 Current index for the test function. More...
 
unsigned int _j
 Current index for the shape function. More...
 
Assembly_assembly
 Reference to the Assembly object. More...
 
const MooseArray< Point > & _q_point
 The physical location of the segment's quadrature points, indexed by _qp. More...
 
const MooseArray< Real > & _JxW
 The current quadrature point weight value. More...
 
unsigned int _qp
 The current quadrature point index. More...
 
const Point & _current_segment_start
 The start point of the current Ray's segment. More...
 
const Point & _current_segment_end
 The end point of the current Ray's segment. More...
 
const Real_current_segment_length
 The length of the current Ray's segment. More...
 
const unsigned short & _current_incoming_side
 The current side of _current_elem that _current_segment_start is on (if any) More...
 
const bool _need_segment_reinit
 Whether or not this RayKernel needs a segment reinit. More...
 
const THREAD_ID _tid
 The thread id. More...
 
FEProblemBase_fe_problem
 The FEProblemBase. More...
 
RayTracingStudy_study
 The RayTracingStudy associated with this object. More...
 
const TraceRay_trace_ray
 The TraceRay object associated with this thread. More...
 
NonlinearSystemBase_nl
 The nonlinear system, we might not have one. More...
 
AuxiliarySystem_aux
 The aux system. More...
 
MooseMesh_mesh
 The MooseMesh. More...
 
const Elem *const & _current_elem
 The current Elem that _current_ray is tracing through. More...
 
const SubdomainID_current_subdomain_id
 The subdomain ID of the _current_elem that the ray is tracing through. More...
 
const unsigned short & _current_intersected_side
 The side that _current_ray intersects (if any) More...
 
const ElemExtrema_current_intersected_extrema
 The elem extrema (vertex/edge) that _current_ray intersects (if any) More...
 
const bool & _enabled
 
MooseApp_app
 
const std::string _type
 
const std::string _name
 
const InputParameters_pars
 
Factory_factory
 
ActionFactory_action_factory
 
const Parallel::Communicator & _communicator
 
const ExecFlagEnum_execute_enum
 
const ExecFlagType_current_execute_flag
 
FEProblemBase_mci_feproblem
 
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
 
const InputParameters_c_parameters
 
const std::string & _c_name
 
const std::string & _c_type
 
FEProblemBase_c_fe_problem
 
const SystemBase *const _c_sys
 
std::unordered_map< std::string, std::vector< MooseVariableFieldBase *> > _coupled_vars
 
std::vector< MooseVariableFieldBase *> _coupled_moose_vars
 
std::vector< MooseVariable *> _coupled_standard_moose_vars
 
std::vector< VectorMooseVariable *> _coupled_vector_moose_vars
 
std::vector< ArrayMooseVariable *> _coupled_array_moose_vars
 
std::vector< MooseVariableFV< Real > *> _coupled_standard_fv_moose_vars
 
std::vector< MooseLinearVariableFV< Real > *> _coupled_standard_linear_fv_moose_vars
 
const std::unordered_map< std::string, std::string > & _new_to_deprecated_coupled_vars
 
bool _c_nodal
 
bool _c_is_implicit
 
const bool _c_allow_element_to_nodal_coupling
 
THREAD_ID _c_tid
 
std::unordered_map< std::string, std::vector< std::unique_ptr< VariableValue > > > _default_value
 
std::unordered_map< std::string, std::unique_ptr< MooseArray< ADReal > > > _ad_default_value
 
std::unordered_map< std::string, std::unique_ptr< VectorVariableValue > > _default_vector_value
 
std::unordered_map< std::string, std::unique_ptr< ArrayVariableValue > > _default_array_value
 
std::unordered_map< std::string, std::unique_ptr< MooseArray< ADRealVectorValue > > > _ad_default_vector_value
 
VariableValue _default_value_zero
 
VariableGradient _default_gradient
 
MooseArray< ADRealVectorValue_ad_default_gradient
 
MooseArray< ADRealTensorValue_ad_default_vector_gradient
 
VariableSecond _default_second
 
MooseArray< ADRealTensorValue_ad_default_second
 
MooseArray< ADRealVectorValue_ad_default_curl
 
const VariableValue_zero
 
const VariablePhiValue_phi_zero
 
const MooseArray< ADReal > & _ad_zero
 
const VariableGradient_grad_zero
 
const MooseArray< ADRealVectorValue > & _ad_grad_zero
 
const VariablePhiGradient_grad_phi_zero
 
const VariableSecond_second_zero
 
const MooseArray< ADRealTensorValue > & _ad_second_zero
 
const VariablePhiSecond_second_phi_zero
 
const VectorVariableValue_vector_zero
 
const VectorVariableCurl_vector_curl_zero
 
VectorVariableValue _default_vector_value_zero
 
VectorVariableGradient _default_vector_gradient
 
VectorVariableCurl _default_vector_curl
 
VectorVariableDivergence _default_div
 
ArrayVariableValue _default_array_value_zero
 
ArrayVariableGradient _default_array_gradient
 
bool _coupleable_neighbor
 
FEProblemBase_sc_fe_problem
 
const THREAD_ID _sc_tid
 
const Real_real_zero
 
const VariableValue_scalar_zero
 
const Point & _point_zero
 
const MaterialData_blk_material_data
 
const InputParameters_mi_params
 
const std::string _mi_name
 
const MooseObjectName _mi_moose_object_name
 
FEProblemBase_mi_feproblem
 
SubProblem_mi_subproblem
 
const THREAD_ID _mi_tid
 
const Moose::MaterialDataType _material_data_type
 
MaterialData_material_data
 
bool _stateful_allowed
 
bool _get_material_property_called
 
std::vector< std::unique_ptr< PropertyValue > > _default_properties
 
std::unordered_set< unsigned int_material_property_dependencies
 
const MaterialPropertyName _get_suffix
 
const bool _use_interpolated_state
 
MooseApp_restartable_app
 
const std::string _restartable_system_name
 
const THREAD_ID _restartable_tid
 
const bool _restartable_read_only
 
bool _nodal
 
MooseVariableFE< T > * _variable
 
MooseVariableFV< T > * _fv_variable
 
MooseLinearVariableFV< T > * _linear_fv_variable
 
MooseVariableField< T > * _field_variable
 
Assembly_mvi_assembly
 
SubProblem_subproblem
 
DenseVector< Number_local_re
 
DenseMatrix< Number_local_ke
 
DenseMatrix< Number_nonlocal_ke
 

Static Protected Attributes

static const std::string _interpolated_old
 
static const std::string _interpolated_older
 

Private Member Functions

void computeJacobian ()
 Computes and contributes to the Jacobian for a segment. More...
 
void computeResidual ()
 Computes and contributes to the residual for a segment. More...
 

Private Attributes

std::vector< ADReal_residuals
 Temporary for filling the residuals. More...
 

Detailed Description

template<typename T>
class ADRayKernelTempl< T >

Base class for an AD ray kernel that contributes to the residual and/or Jacobian.

Definition at line 21 of file ADRayKernel.h.

Constructor & Destructor Documentation

◆ ADRayKernelTempl()

template<typename T >
ADRayKernelTempl< T >::ADRayKernelTempl ( const InputParameters params)

Definition at line 34 of file ADRayKernel.C.

35  : IntegralRayKernelBase(params),
37  false,
38  "variable",
39  Moose::VarKindType::VAR_SOLVER,
40  std::is_same<T, Real>::value ? Moose::VarFieldType::VAR_FIELD_STANDARD
41  : Moose::VarFieldType::VAR_FIELD_VECTOR),
42  TaggingInterface(this),
43  _var(this->mooseVariableField()),
44  _test(_var.phi()),
45  _u(_var.adSln()),
48 {
49  // We do not allow RZ/RSPHERICAL because in the context of these coord
50  // systems there is no way to represent a line source - we would end up
51  // with a plane/surface source or a volumetric source, respectively.
52  // This is also why we do not multiply by _coord[_qp] in any of the
53  // integrations that follow.
54  for (const auto & subdomain_id : _mesh.meshSubdomains())
55  if (_fe_problem.getCoordSystem(subdomain_id) != Moose::COORD_XYZ)
56  mooseError("Not valid on coordinate systems other than XYZ");
57 
59 
61 
62  if (!isImplicit())
63  mooseError("ADRayKernels do not currently support explicit solves.");
64 }
SubProblem & _subproblem
virtual const FieldVariablePhiValue & phi() const =0
virtual void haveADObjects(bool have_ad_objects)
virtual const ADTemplateVariableValue< T > & adSln() const =0
const VariablePhiValue & phi() const
FEProblemBase & _fe_problem
The FEProblemBase.
virtual const ADTemplateVariableGradient< T > & adGradSln() const =0
const ADTemplateVariableValue< T > & _u
Holds the solution at current quadrature points.
Definition: ADRayKernel.h:65
MooseVariableField< T > & variable()
The MooseVariable this RayKernel contributes to.
Definition: ADRayKernel.h:43
const ADTemplateVariablePhiValue< T > & _phi
The current shape functions.
Definition: ADRayKernel.h:71
IntegralRayKernelBase(const InputParameters &params)
TaggingInterface(const MooseObject *moose_object)
MooseMesh & _mesh
The MooseMesh.
MooseVariableField< T > & _var
The MooseVariable this kernel contributes to.
Definition: ADRayKernel.h:56
void addMooseVariableDependency(MooseVariableFieldBase *var)
const ADTemplateVariableTestValue< T > & _test
The current test function.
Definition: ADRayKernel.h:62
Assembly & _assembly
Reference to the Assembly object.
MooseVariableField< T > & mooseVariableField()
void mooseError(Args &&... args) const
Moose::CoordinateSystemType getCoordSystem(SubdomainID sid) const
const std::set< SubdomainID > & meshSubdomains() const
const ADTemplateVariableGradient< T > & _grad_u
Holds the solution gradient at the current quadrature points.
Definition: ADRayKernel.h:68

Member Function Documentation

◆ acquireRay()

std::shared_ptr< Ray > RayKernelBase::acquireRay ( const Point &  start,
const Point &  direction 
)
protectedinherited

Acquires a Ray to be used for generating a new Ray while tracing on the boundary.

Appropriately sets the information needed:

  • Sizes the Ray's data to the size needed by the study
  • Sets the starting elem to the current element
  • Sets the start point to start
  • Sets the direction as provided by direction
  • Sets the RayID to something unique

Definition at line 98 of file RayKernelBase.C.

Referenced by CreateRayRayKernelTest::onSegment().

99 {
100  mooseAssert(_study.currentlyPropagating(), "Should not be getting a Ray while not propagating");
101 
102  // Acquire a Ray with the proper sizes and a unique ID, and set the start info
103  std::shared_ptr<Ray> ray =
105  ray->setStart(start, _current_elem, RayTracingCommon::invalid_side);
106  ray->setStartingDirection(direction);
107 
108  return ray;
109 }
static const unsigned short invalid_side
Identifier for an invalid side index.
Key that is used for restricting access to moveRayToBufferDuringTrace() and acquireRayDuringTrace().
std::shared_ptr< Ray > acquireRayDuringTrace(const THREAD_ID tid, const AcquireMoveDuringTraceKey &)
INTERNAL methods for acquiring a Ray during a trace in RayKernels and RayBCs.
const Elem *const & _current_elem
The current Elem that _current_ray is tracing through.
const THREAD_ID _tid
The thread id.
bool currentlyPropagating() const
Whether or not the study is propagating (tracing Rays)
RayTracingStudy & _study
The RayTracingStudy associated with this object.

◆ changeRayStartDirection()

void RayKernelBase::changeRayStartDirection ( const Point &  start,
const Point &  direction 
)
protectedinherited

Changes the current Ray's start point and direction.

The start point must be within the current element.

Definition at line 63 of file RayKernelBase.C.

Referenced by ChangeRayRayKernelTest::onSegment(), and RefractionRayKernelTest::onSegment().

64 {
65  mooseAssert(_study.currentlyPropagating(), "Should not change Ray outside of tracing");
66 
67  const auto & ray = currentRay();
68 
69  if (!ray->shouldContinue())
70  {
71  if (ray->endSet() && ray->atEnd())
72  mooseError("Cannot changeRayStartDirection() for a Ray that should not continue.\n\n",
73  "It has also hit its user-set end point.\n\n",
74  ray->getInfo());
75  else
76  mooseError("Cannot changeRayStartDirection() for a Ray that should not continue.\n\n",
77  ray->getInfo());
78  }
79 
80  if (ray->trajectoryChanged())
81  mooseError("Cannot change a Ray's trajectory when its trajectory has already been changed\n\n",
82  ray->getInfo());
83 
84  if (ray->endSet())
85  mooseError("Cannot change the direction of a Ray whose end point is set upon generation "
86  "(via setStartingEndPoint()).\n\n",
87  ray->getInfo());
88 
89  if (_study.verifyRays() && !_current_elem->contains_point(start))
90  mooseError("A Ray's start point was changed within a RayKernel, and said start point\n",
91  "is not within the element that the RayKernel was executed on.\n\n",
92  ray->getInfo());
93 
94  ray->changeStartDirection(start, direction, Ray::ChangeStartDirectionKey());
95 }
const std::shared_ptr< Ray > & currentRay() const
Gets the current Ray that this is working on.
bool verifyRays() const
Whether or not to verify if Rays have valid information before being traced.
const Elem *const & _current_elem
The current Elem that _current_ray is tracing through.
bool currentlyPropagating() const
Whether or not the study is propagating (tracing Rays)
Class that is used as a parameter to changeStartDirection() that allows only RayKernelBase methods to...
Definition: Ray.h:74
void mooseError(Args &&... args) const
RayTracingStudy & _study
The RayTracingStudy associated with this object.

◆ computeJacobian()

template<typename T >
void ADRayKernelTempl< T >::computeJacobian ( )
private

Computes and contributes to the Jacobian for a segment.

Definition at line 96 of file ADRayKernel.C.

97 {
99 
100  for (auto & r : _residuals)
101  r = 0;
102  _residuals.resize(_test.size(), 0);
103 
105  for (_qp = 0; _qp < _JxW.size(); _qp++)
106  for (_i = 0; _i < _test.size(); _i++)
108 
110 }
virtual void prepareShapes(unsigned int var, const THREAD_ID tid)=0
std::vector< ADReal > _residuals
Temporary for filling the residuals.
Definition: ADRayKernel.h:90
SubProblem & _subproblem
unsigned int number() const
unsigned int _i
Current index for the test function.
Definition: ADRayKernel.h:74
void addJacobian(Assembly &assembly, const Residuals &residuals, const Indices &dof_indices, Real scaling_factor)
unsigned int size() const
virtual const std::vector< dof_id_type > & dofIndices() const
const THREAD_ID _tid
The thread id.
MooseVariableField< T > & _var
The MooseVariable this kernel contributes to.
Definition: ADRayKernel.h:56
virtual ADReal computeQpResidual()=0
Compute this kernel&#39;s contribution to the residual at _qp and _i.
const MooseArray< Real > & _JxW
The current quadrature point weight value.
unsigned int _qp
The current quadrature point index.
const ADTemplateVariableTestValue< T > & _test
The current test function.
Definition: ADRayKernel.h:62
Assembly & _assembly
Reference to the Assembly object.
virtual void precalculateResidual()
Insertion point for calculation before the residual computation.
Definition: ADRayKernel.h:56
void scalingFactor(const std::vector< Real > &factor)

◆ computeQpResidual()

template<typename T >
virtual ADReal ADRayKernelTempl< T >::computeQpResidual ( )
protectedpure virtual

Compute this kernel's contribution to the residual at _qp and _i.

◆ computeResidual()

template<typename T >
void ADRayKernelTempl< T >::computeResidual ( )
private

Computes and contributes to the residual for a segment.

Definition at line 82 of file ADRayKernel.C.

83 {
85 
87  for (_qp = 0; _qp < _JxW.size(); _qp++)
88  for (_i = 0; _i < _test.size(); _i++)
90 
92 }
void accumulateTaggedLocalResidual()
unsigned int number() const
unsigned int _i
Current index for the test function.
Definition: ADRayKernel.h:74
auto raw_value(const Eigen::Map< T > &in)
unsigned int size() const
MooseVariableField< T > & _var
The MooseVariable this kernel contributes to.
Definition: ADRayKernel.h:56
virtual ADReal computeQpResidual()=0
Compute this kernel&#39;s contribution to the residual at _qp and _i.
const MooseArray< Real > & _JxW
The current quadrature point weight value.
unsigned int _qp
The current quadrature point index.
const ADTemplateVariableTestValue< T > & _test
The current test function.
Definition: ADRayKernel.h:62
Assembly & _assembly
Reference to the Assembly object.
DenseVector< Number > _local_re
void prepareVectorTag(Assembly &assembly, unsigned int ivar)
virtual void precalculateResidual()
Insertion point for calculation before the residual computation.
Definition: ADRayKernel.h:56

◆ currentRay()

const std::shared_ptr<Ray>& RayTracingObject::currentRay ( ) const
inlineprotectedinherited

◆ dependsOn()

void RayTracingObject::dependsOn ( const std::string  name)
inlineprotectedinherited

Add an object of this classes base type that this class depends on.

Definition at line 88 of file RayTracingObject.h.

Referenced by RayBoundaryConditionBase::RayBoundaryConditionBase(), and RayKernelBase::RayKernelBase().

88 { _depend_names.insert(name); }
virtual const std::string & name() const
std::set< std::string > _depend_names
The names of the objects this depends on.

◆ getNonlinearSystem()

NonlinearSystemBase * RayTracingObject::getNonlinearSystem ( )
protectedinherited

Get the right nonlinear system.

Some simulations might not have one, if some user objects only operate on aux variables we need a special treatment

Definition at line 66 of file RayTracingObject.C.

67 {
68  // If this object actually operates with a nonlinear variable that belongs to a system
69  // we use the variable's system
72 
73  // If the user operates on auxiliary variables we just use the first nonlinear
74  // system if there is any
77 
78  return nullptr;
79 }
virtual std::size_t numNonlinearSystems() const override
FEProblemBase & _fe_problem
The FEProblemBase.
NonlinearSystemBase & getNonlinearSystemBase(const unsigned int sys_num)
RayTracingStudy & _study
The RayTracingStudy associated with this object.
unsigned int systemNumber() const

◆ getRequestedItems()

const std::set<std::string>& RayTracingObject::getRequestedItems ( )
inlineoverridevirtualinherited

Implements DependencyResolverInterface.

Definition at line 51 of file RayTracingObject.h.

51 { return _depend_names; }
std::set< std::string > _depend_names
The names of the objects this depends on.

◆ getStudy()

template<typename T >
T & RayTracingObject::getStudy ( )
inherited

Casts the RayTracingStudy associated with this object to a study of type T with a meaningful error message if it fails.

Definition at line 137 of file RayTracingObject.h.

138 {
139  static_assert(std::is_base_of<RayTracingStudy, T>::value, "Not derived from a RayTracingStudy");
140 
141  if (T * cast_study = dynamic_cast<T *>(&_study))
142  return *cast_study;
143 
144  std::stringstream err;
145  err << "Supplied study of type " << _study.type() << " is not the required study type "
146  << MooseUtils::prettyCppType<T>();
147  if (isParamValid("study"))
148  paramError("study", err.str());
149  else
150  mooseError(err.str());
151 }
OStreamProxy err
bool isParamValid(const std::string &name) const
const std::string & type() const
void paramError(const std::string &param, Args... args) const
void mooseError(Args &&... args) const
RayTracingStudy & _study
The RayTracingStudy associated with this object.

◆ getSuppliedItems()

const std::set<std::string>& RayTracingObject::getSuppliedItems ( )
inlineoverridevirtualinherited

Implements DependencyResolverInterface.

Definition at line 52 of file RayTracingObject.h.

52 { return _supplied_names; }
std::set< std::string > _supplied_names
The names of the supplied objects: just this one.

◆ moveRayToBuffer()

void RayKernelBase::moveRayToBuffer ( std::shared_ptr< Ray > &  ray)
protectedinherited

Moves a Ray into the working buffer to be traced during tracing with a meaningful error on verification failure.

Definition at line 112 of file RayKernelBase.C.

Referenced by CreateRayRayKernelTest::onSegment().

113 {
114  mooseAssert(_study.currentlyPropagating(),
115  "Should not move Rays into buffer while not propagating");
116 
118 }
void moveRayToBufferDuringTrace(std::shared_ptr< Ray > &ray, const THREAD_ID tid, const AcquireMoveDuringTraceKey &)
INTERNAL method for moving a Ray into the buffer during tracing.
Key that is used for restricting access to moveRayToBufferDuringTrace() and acquireRayDuringTrace().
const THREAD_ID _tid
The thread id.
bool currentlyPropagating() const
Whether or not the study is propagating (tracing Rays)
RayTracingStudy & _study
The RayTracingStudy associated with this object.

◆ needSegmentReinit()

bool RayKernelBase::needSegmentReinit ( ) const
inlineinherited

Whether or not this RayKernel needs a segment reinit.

Definition at line 74 of file RayKernelBase.h.

Referenced by IntegralRayKernelBase::preExecuteStudy().

74 { return _need_segment_reinit; }
const bool _need_segment_reinit
Whether or not this RayKernel needs a segment reinit.

◆ onSegment()

template<typename T >
void ADRayKernelTempl< T >::onSegment ( )
finaloverridevirtual

Called on each segment of a Ray.

Important information available during onSegment(): currentRay() - The current Ray that is being traced on the segment _current_elem - The current Elem the Ray is tracing in _current_segment_start - The start point of the segment _current_segment_end - The end point of the segment _current_segment_length - The length of the segment _current_intersected_side - The side intersected on _current_elem (if any) _current_intersected_extrema - The extrema (vertex/edge) intersected on _current_elem (if any) _current_incoming_side - The side of _current_elem that _current_segment_start is on (if any)

Implements IntegralRayKernelBase.

Definition at line 68 of file ADRayKernel.C.

69 {
70  mooseAssert(_current_subdomain_id == _assembly.currentSubdomainID(), "Subdomain IDs not in sync");
72  "Not computing residual or Jacobian");
73 
78 }
FEProblemBase & _fe_problem
The FEProblemBase.
const bool & currentlyComputingResidual() const
void computeResidual()
Computes and contributes to the residual for a segment.
Definition: ADRayKernel.C:82
Assembly & _assembly
Reference to the Assembly object.
const SubdomainID & _current_subdomain_id
The subdomain ID of the _current_elem that the ray is tracing through.
const SubdomainID & currentSubdomainID() const
const bool & currentlyComputingJacobian() const
void computeJacobian()
Computes and contributes to the Jacobian for a segment.
Definition: ADRayKernel.C:96

◆ postExecuteStudy()

virtual void RayTracingObject::postExecuteStudy ( )
inlinevirtualinherited

Insertion point called immediately after executing the RayTracingStudy.

Definition at line 77 of file RayTracingObject.h.

77 {};

◆ postTrace()

void RayKernelBase::postTrace ( )
virtualinherited

This method is called once a ray has reached the end of its trace.

Definition at line 126 of file RayKernelBase.C.

127 {
128 }

◆ precalculateResidual()

template<typename T >
virtual void ADRayKernelTempl< T >::precalculateResidual ( )
inlineprotectedvirtual

Insertion point for calculation before the residual computation.

Definition at line 56 of file ADRayKernel.h.

56 {};

◆ preExecuteStudy()

void IntegralRayKernelBase::preExecuteStudy ( )
overridevirtualinherited

Insertion point called immediately before executing the RayTracingStudy.

Reimplemented from RayTracingObject.

Definition at line 38 of file IntegralRayKernelBase.C.

39 {
40  mooseAssert(needSegmentReinit(), "Must be true");
41 }
bool needSegmentReinit() const
Whether or not this RayKernel needs a segment reinit.
Definition: RayKernelBase.h:74

◆ preTrace()

void RayKernelBase::preTrace ( )
virtualinherited

Called at the beginning of the trace on this processor/thread for a Ray.

This is not only called at the true beginning of the Ray, but instead it is called every time this processor/thread starts the trace for the part it can trace

Definition at line 121 of file RayKernelBase.C.

122 {
123 }

◆ study() [1/2]

RayTracingStudy& RayTracingObject::study ( )
inlineinherited

The RayTracingStudy associated with this object.

Definition at line 57 of file RayTracingObject.h.

Referenced by AttribRayTracingStudy::initFrom().

57 { return _study; }
RayTracingStudy & _study
The RayTracingStudy associated with this object.

◆ study() [2/2]

const RayTracingStudy& RayTracingObject::study ( ) const
inlineinherited

The RayTracingStudy associated with this object.

Definition at line 61 of file RayTracingObject.h.

61 { return _study; }
RayTracingStudy & _study
The RayTracingStudy associated with this object.

◆ validParams()

template<typename T >
InputParameters ADRayKernelTempl< T >::validParams ( )
static

Definition at line 22 of file ADRayKernel.C.

Referenced by GenericRayKernel< true >::validParams().

23 {
24  auto params = IntegralRayKernelBase::validParams();
26 
27  params.template addRequiredParam<NonlinearVariableName>(
28  "variable", "The name of the variable that this ADRayKernel operates on");
29 
30  return params;
31 }
static InputParameters validParams()
static InputParameters validParams()

◆ variable()

template<typename T >
MooseVariableField<T>& ADRayKernelTempl< T >::variable ( )
inline

The MooseVariable this RayKernel contributes to.

Definition at line 43 of file ADRayKernel.h.

Referenced by ADRayKernelTempl< T >::ADRayKernelTempl().

43 { return _var; }
MooseVariableField< T > & _var
The MooseVariable this kernel contributes to.
Definition: ADRayKernel.h:56

Member Data Documentation

◆ _assembly

Assembly& IntegralRayKernelBase::_assembly
protectedinherited

Reference to the Assembly object.

Definition at line 33 of file IntegralRayKernelBase.h.

◆ _aux

AuxiliarySystem& RayTracingObject::_aux
protectedinherited

The aux system.

Definition at line 111 of file RayTracingObject.h.

◆ _current_elem

const Elem* const& RayTracingObject::_current_elem
protectedinherited

◆ _current_incoming_side

const unsigned short& RayKernelBase::_current_incoming_side
protectedinherited

The current side of _current_elem that _current_segment_start is on (if any)

Definition at line 109 of file RayKernelBase.h.

◆ _current_intersected_extrema

const ElemExtrema& RayTracingObject::_current_intersected_extrema
protectedinherited

The elem extrema (vertex/edge) that _current_ray intersects (if any)

Definition at line 123 of file RayTracingObject.h.

◆ _current_intersected_side

const unsigned short& RayTracingObject::_current_intersected_side
protectedinherited

The side that _current_ray intersects (if any)

Definition at line 121 of file RayTracingObject.h.

Referenced by RayBoundaryConditionBase::acquireRay(), and ReflectRayBC::onBoundary().

◆ _current_segment_end

const Point& RayKernelBase::_current_segment_end
protectedinherited

The end point of the current Ray's segment.

Definition at line 105 of file RayKernelBase.h.

Referenced by CreateRayRayKernelTest::onSegment(), FunctionAuxRayKernelTest::onSegment(), and RefractionRayKernelTest::onSegment().

◆ _current_segment_length

const Real& RayKernelBase::_current_segment_length
protectedinherited

The length of the current Ray's segment.

Definition at line 107 of file RayKernelBase.h.

Referenced by RayDistanceAux::onSegment(), TestRayDataRayKernel::onSegment(), and IntegralRayKernel::onSegment().

◆ _current_segment_start

const Point& RayKernelBase::_current_segment_start
protectedinherited

The start point of the current Ray's segment.

Definition at line 103 of file RayKernelBase.h.

Referenced by CreateRayRayKernelTest::onSegment(), FunctionAuxRayKernelTest::onSegment(), and RefractionRayKernelTest::onSegment().

◆ _current_subdomain_id

const SubdomainID& RayTracingObject::_current_subdomain_id
protectedinherited

The subdomain ID of the _current_elem that the ray is tracing through.

Definition at line 119 of file RayTracingObject.h.

◆ _fe_problem

FEProblemBase& RayTracingObject::_fe_problem
protectedinherited

◆ _grad_u

template<typename T >
const ADTemplateVariableGradient<T>& ADRayKernelTempl< T >::_grad_u
protected

Holds the solution gradient at the current quadrature points.

Definition at line 68 of file ADRayKernel.h.

◆ _i

template<typename T >
unsigned int ADRayKernelTempl< T >::_i
protected

Current index for the test function.

Definition at line 74 of file ADRayKernel.h.

◆ _j

template<typename T >
unsigned int ADRayKernelTempl< T >::_j
protected

Current index for the shape function.

Definition at line 77 of file ADRayKernel.h.

◆ _JxW

const MooseArray<Real>& IntegralRayKernelBase::_JxW
protectedinherited

The current quadrature point weight value.

Definition at line 39 of file IntegralRayKernelBase.h.

Referenced by IntegralRayKernel::onSegment().

◆ _mesh

MooseMesh& RayTracingObject::_mesh
protectedinherited

◆ _need_segment_reinit

const bool RayKernelBase::_need_segment_reinit
protectedinherited

Whether or not this RayKernel needs a segment reinit.

Definition at line 112 of file RayKernelBase.h.

Referenced by RayKernelBase::needSegmentReinit().

◆ _nl

NonlinearSystemBase* RayTracingObject::_nl
protectedinherited

The nonlinear system, we might not have one.

Definition at line 109 of file RayTracingObject.h.

◆ _phi

template<typename T >
const ADTemplateVariablePhiValue<T>& ADRayKernelTempl< T >::_phi
protected

The current shape functions.

Definition at line 71 of file ADRayKernel.h.

◆ _q_point

const MooseArray<Point>& IntegralRayKernelBase::_q_point
protectedinherited

The physical location of the segment's quadrature points, indexed by _qp.

Definition at line 36 of file IntegralRayKernelBase.h.

Referenced by FunctionIntegralRayKernel::computeQpIntegral(), and IntegralRayKernel::onSegment().

◆ _qp

unsigned int IntegralRayKernelBase::_qp
protectedinherited

◆ _residuals

template<typename T >
std::vector<ADReal> ADRayKernelTempl< T >::_residuals
private

Temporary for filling the residuals.

Definition at line 90 of file ADRayKernel.h.

◆ _study

RayTracingStudy& RayTracingObject::_study
protectedinherited

◆ _test

template<typename T >
const ADTemplateVariableTestValue<T>& ADRayKernelTempl< T >::_test
protected

The current test function.

Definition at line 62 of file ADRayKernel.h.

◆ _tid

const THREAD_ID RayTracingObject::_tid
protectedinherited

◆ _trace_ray

const TraceRay& RayTracingObject::_trace_ray
protectedinherited

The TraceRay object associated with this thread.

Definition at line 106 of file RayTracingObject.h.

◆ _u

template<typename T >
const ADTemplateVariableValue<T>& ADRayKernelTempl< T >::_u
protected

Holds the solution at current quadrature points.

Definition at line 65 of file ADRayKernel.h.

◆ _var

template<typename T >
MooseVariableField<T>& ADRayKernelTempl< T >::_var
protected

The MooseVariable this kernel contributes to.

Definition at line 56 of file ADRayKernel.h.

Referenced by ADRayKernelTempl< T >::variable().


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