Loading [MathJax]/extensions/tex2jax.js
https://mooseframework.inl.gov
•All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends
Public Types | Public Member Functions | Static Public Member Functions | Public Attributes | Static Public Attributes | Protected Member Functions | Static Protected Member Functions | Protected Attributes | Static Protected Attributes | List of all members
LineMaterialRankTwoScalarSampler Class Reference

This class samples RankTwoTensor material properties for the integration points in all elements that are intersected by a user-defined line. More...

#include <LineMaterialRankTwoScalarSampler.h>

Inheritance diagram for LineMaterialRankTwoScalarSampler:
[legend]

Public Types

typedef DataFileName DataFileParameterType
 

Public Member Functions

 LineMaterialRankTwoScalarSampler (const InputParameters &parameters)
 Class constructor Sets up variables for output based on the properties to be output. More...
 
virtual Real getScalarFromProperty (const RankTwoTensor &property, const Point &curr_point)
 Reduce the RankTwoTensor material property to a scalar for output Call through to RankTwoScalarTools::getQuantity to access the full set of options for reducing the RankTwoTensor to a scalar quantity. More...
 
virtual void initialize () override
 
virtual void execute () override
 
virtual void finalize () override
 
SubProblem & getSubProblem () const
 
bool shouldDuplicateInitialExecution () const
 
virtual Real spatialValue (const Point &) const
 
virtual const std::vector< Point > spatialPoints () const
 
void gatherSum (RankTwoTensor &value)
 
void gatherSum (T &value)
 
void gatherMax (RankTwoTensor &value)
 
void gatherMax (T &value)
 
void gatherMin (RankTwoTensor &value)
 
void gatherMin (T &value)
 
void gatherProxyValueMax (T1 &proxy, T2 &value)
 
void gatherProxyValueMin (T1 &proxy, T2 &value)
 
void setPrimaryThreadCopy (UserObject *primary)
 
UserObject * primaryThreadCopy ()
 
std::set< UserObjectName > getDependObjects () const
 
virtual bool needThreadedCopy () const
 
const std::set< std::string > & getRequestedItems () override
 
const std::set< std::string > & getSuppliedItems () override
 
unsigned int systemNumber () const
 
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 RankTwoTensor & getParam (const std::string &name) const
 
std::vector< std::pair< T1, T2 > > getParam (const std::string &param1, const std::string &param2) const
 
const RankTwoTensor & getRenamedParam (const std::string &old_name, const std::string &new_name) const
 
RankTwoTensor 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
 
virtual void initialSetup ()
 
virtual void timestepSetup ()
 
virtual void jacobianSetup ()
 
virtual void residualSetup ()
 
virtual void customSetup (const ExecFlagType &)
 
const ExecFlagEnum & getExecuteOnEnum () const
 
UserObjectName getUserObjectName (const std::string &param_name) const
 
const RankTwoTensor & getUserObject (const std::string &param_name, bool is_dependency=true) const
 
const RankTwoTensor & 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
 
const std::vector< MooseVariableScalar * > & getCoupledMooseScalarVars ()
 
const std::set< TagID > & getScalarVariableCoupleableVectorTags () const
 
const std::set< TagID > & getScalarVariableCoupleableMatrixTags () const
 
const GenericMaterialProperty< RankTwoTensor, is_ad > & getGenericMaterialProperty (const std::string &name, MaterialData &material_data, const unsigned int state=0)
 
const GenericMaterialProperty< RankTwoTensor, is_ad > & getGenericMaterialProperty (const std::string &name, const unsigned int state=0)
 
const GenericMaterialProperty< RankTwoTensor, is_ad > & getGenericMaterialProperty (const std::string &name, const unsigned int state=0)
 
const MaterialProperty< RankTwoTensor > & getMaterialProperty (const std::string &name, MaterialData &material_data, const unsigned int state=0)
 
const MaterialProperty< RankTwoTensor > & getMaterialProperty (const std::string &name, const unsigned int state=0)
 
const MaterialProperty< RankTwoTensor > & getMaterialProperty (const std::string &name, const unsigned int state=0)
 
const ADMaterialProperty< RankTwoTensor > & getADMaterialProperty (const std::string &name, MaterialData &material_data)
 
const ADMaterialProperty< RankTwoTensor > & getADMaterialProperty (const std::string &name)
 
const ADMaterialProperty< RankTwoTensor > & getADMaterialProperty (const std::string &name)
 
const MaterialProperty< RankTwoTensor > & getMaterialPropertyOld (const std::string &name, MaterialData &material_data)
 
const MaterialProperty< RankTwoTensor > & getMaterialPropertyOld (const std::string &name)
 
const MaterialProperty< RankTwoTensor > & getMaterialPropertyOld (const std::string &name)
 
const MaterialProperty< RankTwoTensor > & getMaterialPropertyOlder (const std::string &name, MaterialData &material_data)
 
const MaterialProperty< RankTwoTensor > & getMaterialPropertyOlder (const std::string &name)
 
const MaterialProperty< RankTwoTensor > & getMaterialPropertyOlder (const std::string &name)
 
const GenericMaterialProperty< RankTwoTensor, is_ad > & getGenericMaterialPropertyByName (const MaterialPropertyName &name, MaterialData &material_data, const unsigned int state)
 
const GenericMaterialProperty< RankTwoTensor, is_ad > & getGenericMaterialPropertyByName (const MaterialPropertyName &name, const unsigned int state=0)
 
const GenericMaterialProperty< RankTwoTensor, is_ad > & getGenericMaterialPropertyByName (const MaterialPropertyName &name, const unsigned int state=0)
 
const MaterialProperty< RankTwoTensor > & getMaterialPropertyByName (const MaterialPropertyName &name, MaterialData &material_data, const unsigned int state=0)
 
const MaterialProperty< RankTwoTensor > & getMaterialPropertyByName (const MaterialPropertyName &name, const unsigned int state=0)
 
const MaterialProperty< RankTwoTensor > & getMaterialPropertyByName (const MaterialPropertyName &name, const unsigned int state=0)
 
const ADMaterialProperty< RankTwoTensor > & getADMaterialPropertyByName (const MaterialPropertyName &name, MaterialData &material_data)
 
const ADMaterialProperty< RankTwoTensor > & getADMaterialPropertyByName (const MaterialPropertyName &name)
 
const ADMaterialProperty< RankTwoTensor > & getADMaterialPropertyByName (const MaterialPropertyName &name)
 
const MaterialProperty< RankTwoTensor > & getMaterialPropertyOldByName (const MaterialPropertyName &name, MaterialData &material_data)
 
const MaterialProperty< RankTwoTensor > & getMaterialPropertyOldByName (const MaterialPropertyName &name)
 
const MaterialProperty< RankTwoTensor > & getMaterialPropertyOldByName (const MaterialPropertyName &name)
 
const MaterialProperty< RankTwoTensor > & getMaterialPropertyOlderByName (const MaterialPropertyName &name, MaterialData &material_data)
 
const MaterialProperty< RankTwoTensor > & getMaterialPropertyOlderByName (const MaterialPropertyName &name)
 
const MaterialProperty< RankTwoTensor > & getMaterialPropertyOlderByName (const MaterialPropertyName &name)
 
std::pair< const MaterialProperty< RankTwoTensor > *, std::set< SubdomainID > > getBlockMaterialProperty (const MaterialPropertyName &name)
 
const GenericMaterialProperty< RankTwoTensor, is_ad > & getGenericZeroMaterialProperty (const std::string &name)
 
const GenericMaterialProperty< RankTwoTensor, is_ad > & getGenericZeroMaterialProperty ()
 
const GenericMaterialProperty< RankTwoTensor, is_ad > & getGenericZeroMaterialPropertyByName (const std::string &prop_name)
 
const MaterialProperty< RankTwoTensor > & getZeroMaterialProperty (Ts... args)
 
std::set< SubdomainID > getMaterialPropertyBlocks (const std::string &name)
 
std::vector< SubdomainName > getMaterialPropertyBlockNames (const std::string &name)
 
std::set< BoundaryID > getMaterialPropertyBoundaryIDs (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
 
const std::unordered_set< unsigned int > & getMatPropDependencies () const
 
virtual void resolveOptionalProperties ()
 
const GenericMaterialProperty< RankTwoTensor, is_ad > & getPossiblyConstantGenericMaterialPropertyByName (const MaterialPropertyName &prop_name, MaterialData &material_data, const unsigned int state)
 
bool isImplicit ()
 
Moose::StateArg determineState () const
 
std::string PPName () const
 
bool containsCompleteHistory () const
 
bool isDistributed () const
 
const std::set< std::string > & getVectorNames () const
 
void buildOutputHideVariableList (std::set< std::string > variable_names)
 
const std::set< OutputName > & getOutputs ()
 
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 (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
 
virtual void threadJoin (const UserObject &) override
 
virtual void threadJoin (const UserObject &) override
 
virtual void subdomainSetup () override
 
virtual void subdomainSetup () override
 
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 GenericOptionalMaterialProperty< RankTwoTensor, is_ad > & getGenericOptionalMaterialProperty (const std::string &name, const unsigned int state=0)
 
const GenericOptionalMaterialProperty< RankTwoTensor, is_ad > & getGenericOptionalMaterialProperty (const std::string &name, const unsigned int state=0)
 
const OptionalMaterialProperty< RankTwoTensor > & getOptionalMaterialProperty (const std::string &name, const unsigned int state=0)
 
const OptionalMaterialProperty< RankTwoTensor > & getOptionalMaterialProperty (const std::string &name, const unsigned int state=0)
 
const OptionalADMaterialProperty< RankTwoTensor > & getOptionalADMaterialProperty (const std::string &name)
 
const OptionalADMaterialProperty< RankTwoTensor > & getOptionalADMaterialProperty (const std::string &name)
 
const OptionalMaterialProperty< RankTwoTensor > & getOptionalMaterialPropertyOld (const std::string &name)
 
const OptionalMaterialProperty< RankTwoTensor > & getOptionalMaterialPropertyOld (const std::string &name)
 
const OptionalMaterialProperty< RankTwoTensor > & getOptionalMaterialPropertyOlder (const std::string &name)
 
const OptionalMaterialProperty< RankTwoTensor > & getOptionalMaterialPropertyOlder (const std::string &name)
 
MaterialBase & getMaterial (const std::string &name)
 
MaterialBase & getMaterial (const std::string &name)
 
MaterialBase & getMaterialByName (const std::string &name, bool no_warn=false)
 
MaterialBase & getMaterialByName (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)
 
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
 
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 VectorPostprocessorValue & getVectorPostprocessorValue (const std::string &param_name, const std::string &vector_name) const
 
const VectorPostprocessorValue & getVectorPostprocessorValue (const std::string &param_name, const std::string &vector_name, bool needs_broadcast) const
 
const VectorPostprocessorValue & getVectorPostprocessorValueByName (const VectorPostprocessorName &name, const std::string &vector_name) const
 
const VectorPostprocessorValue & getVectorPostprocessorValueByName (const VectorPostprocessorName &name, const std::string &vector_name, bool needs_broadcast) const
 
const VectorPostprocessorValue & getVectorPostprocessorValueOld (const std::string &param_name, const std::string &vector_name) const
 
const VectorPostprocessorValue & getVectorPostprocessorValueOld (const std::string &param_name, const std::string &vector_name, bool needs_broadcast) const
 
const VectorPostprocessorValue & getVectorPostprocessorValueOldByName (const VectorPostprocessorName &name, const std::string &vector_name) const
 
const VectorPostprocessorValue & getVectorPostprocessorValueOldByName (const VectorPostprocessorName &name, const std::string &vector_name, bool needs_broadcast) const
 
const ScatterVectorPostprocessorValue & getScatterVectorPostprocessorValue (const std::string &param_name, const std::string &vector_name) const
 
const ScatterVectorPostprocessorValue & getScatterVectorPostprocessorValueByName (const VectorPostprocessorName &name, const std::string &vector_name) const
 
const ScatterVectorPostprocessorValue & getScatterVectorPostprocessorValueOld (const std::string &param_name, const std::string &vector_name) const
 
const ScatterVectorPostprocessorValue & getScatterVectorPostprocessorValueOldByName (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
 
RankTwoTensor & getSampler (const std::string &name)
 
Sampler & getSampler (const std::string &name)
 
RankTwoTensor & getSamplerByName (const SamplerName &name)
 
Sampler & getSamplerByName (const SamplerName &name)
 
virtual void meshChanged ()
 
PerfGraph & perfGraph ()
 
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
 
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
 
const Distribution & getDistribution (const std::string &name) const
 
const RankTwoTensor & getDistribution (const std::string &name) const
 
const Distribution & getDistribution (const std::string &name) const
 
const RankTwoTensor & getDistribution (const std::string &name) const
 
const Distribution & getDistributionByName (const DistributionName &name) const
 
const RankTwoTensor & getDistributionByName (const std::string &name) const
 
const Distribution & getDistributionByName (const DistributionName &name) const
 
const RankTwoTensor & getDistributionByName (const std::string &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< RankTwoTensor > &vector)
 
static void sort (typename std::vector< T > &vector)
 
static void sortDFS (typename std::vector< RankTwoTensor > &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
 
static constexpr auto SYSTEM
 
static constexpr auto NAME
 

Protected Member Functions

virtual void threadJoin (const SamplerBase &y)
 
virtual void addPostprocessorDependencyHelper (const PostprocessorName &name) const override
 
virtual void addVectorPostprocessorDependencyHelper (const VectorPostprocessorName &name) const override
 
virtual void addUserObjectDependencyHelper (const UserObject &uo) const override
 
void addReporterDependencyHelper (const ReporterName &reporter_name) override
 
const ReporterName & getReporterName (const std::string &param_name) const
 
RankTwoTensor & declareRestartableData (const std::string &data_name, Args &&... args)
 
ManagedValue< RankTwoTensor > declareManagedRestartableDataWithContext (const std::string &data_name, void *context, Args &&... args)
 
const RankTwoTensor & getRestartableData (const std::string &data_name) const
 
RankTwoTensor & declareRestartableDataWithContext (const std::string &data_name, void *context, Args &&... args)
 
RankTwoTensor & declareRecoverableData (const std::string &data_name, Args &&... args)
 
RankTwoTensor & declareRestartableDataWithObjectName (const std::string &data_name, const std::string &object_name, Args &&... args)
 
RankTwoTensor & declareRestartableDataWithObjectNameWithContext (const std::string &data_name, const std::string &object_name, void *context, Args &&... args)
 
std::string restartableName (const std::string &data_name) const
 
const RankTwoTensor & getMeshProperty (const std::string &data_name, const std::string &prefix)
 
const RankTwoTensor & getMeshProperty (const std::string &data_name)
 
bool hasMeshProperty (const std::string &data_name, const std::string &prefix) const
 
bool hasMeshProperty (const std::string &data_name, const std::string &prefix) const
 
bool hasMeshProperty (const std::string &data_name) const
 
bool hasMeshProperty (const std::string &data_name) const
 
std::string meshPropertyName (const std::string &data_name) const
 
PerfID registerTimedSection (const std::string &section_name, const unsigned int level) const
 
PerfID registerTimedSection (const std::string &section_name, const unsigned int level, const std::string &live_message, const bool print_dots=true) const
 
std::string timedSectionName (const std::string &section_name) 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 checkMaterialProperty (const std::string &name, const unsigned int state)
 
void markMatPropRequested (const std::string &)
 
MaterialPropertyName getMaterialPropertyName (const std::string &name) const
 
void checkExecutionStage ()
 
VectorPostprocessorValue & declareVector (const std::string &vector_name)
 
void setupVariables (const std::vector< std::string > &variable_names)
 
void checkForStandardFieldVariableType (const MooseVariableFieldBase *const var_ptr, const std::string &var_param_name="variable") const
 
virtual void addSample (const Point &p, const Real &id, const std::vector< Real > &values)
 
virtual bool hasBlockMaterialPropertyHelper (const std::string &prop_name)
 
void initializeBlockRestrictable (const MooseObject *moose_object)
 
Moose::CoordinateSystemType getBlockCoordSystem ()
 
const RankTwoTensor & getReporterValue (const std::string &param_name, const std::size_t time_index=0)
 
const RankTwoTensor & getReporterValue (const std::string &param_name, ReporterMode mode, const std::size_t time_index=0)
 
const RankTwoTensor & getReporterValue (const std::string &param_name, const std::size_t time_index=0)
 
const RankTwoTensor & getReporterValue (const std::string &param_name, ReporterMode mode, const std::size_t time_index=0)
 
const RankTwoTensor & getReporterValueByName (const ReporterName &reporter_name, const std::size_t time_index=0)
 
const RankTwoTensor & getReporterValueByName (const ReporterName &reporter_name, ReporterMode mode, const std::size_t time_index=0)
 
const RankTwoTensor & getReporterValueByName (const ReporterName &reporter_name, const std::size_t time_index=0)
 
const RankTwoTensor & getReporterValueByName (const ReporterName &reporter_name, ReporterMode mode, const std::size_t time_index=0)
 
bool hasReporterValue (const std::string &param_name) const
 
bool hasReporterValue (const std::string &param_name) const
 
bool hasReporterValue (const std::string &param_name) const
 
bool hasReporterValue (const std::string &param_name) const
 
bool hasReporterValueByName (const ReporterName &reporter_name) const
 
bool hasReporterValueByName (const ReporterName &reporter_name) const
 
bool hasReporterValueByName (const ReporterName &reporter_name) const
 
bool hasReporterValueByName (const ReporterName &reporter_name) const
 
const GenericMaterialProperty< RankTwoTensor, is_ad > * defaultGenericMaterialProperty (const std::string &name)
 
const GenericMaterialProperty< RankTwoTensor, is_ad > * defaultGenericMaterialProperty (const std::string &name)
 
const MaterialProperty< RankTwoTensor > * defaultMaterialProperty (const std::string &name)
 
const MaterialProperty< RankTwoTensor > * defaultMaterialProperty (const std::string &name)
 
const ADMaterialProperty< RankTwoTensor > * defaultADMaterialProperty (const std::string &name)
 
const ADMaterialProperty< RankTwoTensor > * defaultADMaterialProperty (const std::string &name)
 

Static Protected Member Functions

static std::string meshPropertyName (const std::string &data_name, const std::string &prefix)
 

Protected Attributes

MooseEnum _scalar_type
 
const Point _point1
 
const Point _point2
 
Point _direction
 
Point _start
 
Point _end
 
std::vector< const MaterialProperty< RankTwoTensor > * > _material_properties
 
MooseMesh & _mesh
 
const QBase *const & _qrule
 
const MooseArray< Point > & _q_point
 
SubProblem & _subproblem
 
FEProblemBase & _fe_problem
 
SystemBase & _sys
 
const THREAD_ID _tid
 
Assembly & _assembly
 
const Moose::CoordinateSystemType & _coord_sys
 
const bool _duplicate_initial_execution
 
std::set< std::string > _depend_uo
 
const bool & _enabled
 
MooseApp & _app
 
const std::string _type
 
const std::string _name
 
const InputParameters & _pars
 
Factory & _factory
 
ActionFactory & _action_factory
 
const ExecFlagEnum & _execute_enum
 
const ExecFlagType & _current_execute_flag
 
MooseApp & _restartable_app
 
const std::string _restartable_system_name
 
const THREAD_ID _restartable_tid
 
const bool _restartable_read_only
 
FEProblemBase & _mci_feproblem
 
MooseApp & _pg_moose_app
 
const std::string _prefix
 
FEProblemBase & _sc_fe_problem
 
const THREAD_ID _sc_tid
 
const Real & _real_zero
 
const VariableValue & _scalar_zero
 
const Point & _point_zero
 
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
 
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 std::string _vpp_name
 
FEProblemBase & _vpp_fe_problem
 
const MooseEnum & _parallel_type
 
const InputParameters & _sampler_params
 
VectorPostprocessor * _vpp
 
const libMesh::Parallel::Communicator & _comm
 
std::vector< std::string > _variable_names
 
const unsigned int _sort_by
 
VectorPostprocessorValue & _x
 
VectorPostprocessorValue & _y
 
VectorPostprocessorValue & _z
 
VectorPostprocessorValue & _id
 
std::vector< VectorPostprocessorValue * > _values
 
const MaterialData * _blk_material_data
 
const Parallel::Communicator & _communicator
 

Static Protected Attributes

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

Detailed Description

This class samples RankTwoTensor material properties for the integration points in all elements that are intersected by a user-defined line.

It provides access to the full set of options for reducing the RankTwoTensor to a scalar

Definition at line 22 of file LineMaterialRankTwoScalarSampler.h.

Constructor & Destructor Documentation

◆ LineMaterialRankTwoScalarSampler()

LineMaterialRankTwoScalarSampler::LineMaterialRankTwoScalarSampler ( const InputParameters &  parameters)

Class constructor Sets up variables for output based on the properties to be output.

Parameters
parametersThe input parameters

Definition at line 33 of file LineMaterialRankTwoScalarSampler.C.

35  : LineMaterialSamplerBase<RankTwoTensor>(parameters),
36  _scalar_type(getParam<MooseEnum>("scalar_type")),
37  _point1(parameters.get<Point>("point1")),
38  _point2(parameters.get<Point>("point2")),
39  _direction(parameters.get<Point>("direction") / parameters.get<Point>("direction").norm())
40 {
41 }
InputParameters::get
std::vector< std::pair< R1, R2 > > get(const std::string &param1, const std::string &param2) const
norm
auto norm(const T &a) -> decltype(std::abs(a))
LineMaterialSamplerBase< RankTwoTensor >::parameters
const InputParameters & parameters() const

Member Function Documentation

◆ getScalarFromProperty()

Real LineMaterialRankTwoScalarSampler::getScalarFromProperty ( const RankTwoTensor &  property,
const Point &  curr_point 
)
virtual

Reduce the RankTwoTensor material property to a scalar for output Call through to RankTwoScalarTools::getQuantity to access the full set of options for reducing the RankTwoTensor to a scalar quantity.

Parameters
propertyThe material property
curr_pointThe point corresponding to this material property
Returns
A scalar value from this material property to be output

Implements LineMaterialSamplerBase< RankTwoTensor >.

Definition at line 44 of file LineMaterialRankTwoScalarSampler.C.

46 {
47  return RankTwoScalarTools::getQuantity(
48  property, _scalar_type, _point1, _point2, curr_point, _direction);
49 }
RankTwoScalarTools::getQuantity
T getQuantity(const RankTwoTensorTempl< T > &tensor, const MooseEnum &scalar_type, const Point &point1, const Point &point2, const Point &curr_point, Point &direction)
Definition: RankTwoScalarTools.h:527

◆ validParams()

InputParameters LineMaterialRankTwoScalarSampler::validParams ( )
static

Definition at line 16 of file LineMaterialRankTwoScalarSampler.C.

17 {
18  InputParameters params = LineMaterialSamplerBase<Real>::validParams();
19  params.addClassDescription("Compute a scalar property of a RankTwoTensor");
20  params.addParam<MooseEnum>(
21  "scalar_type", RankTwoScalarTools::scalarOptions(), "A scalar to output");
22  params.addParam<Point>(
23  "point1",
24  Point(0, 0, 0),
25  "Start point for axis used to calculate some cylindrical material tensor quantities");
26  params.addParam<Point>("point2",
27  Point(0, 1, 0),
28  "End point for axis used to calculate some material tensor quantities");
29  params.addParam<Point>("direction", Point(0, 0, 1), "Direction vector");
30  return params;
31 }
LineMaterialSamplerBase::validParams
static InputParameters validParams()
InputParameters::addParam
void addParam(const std::string &name, const std::initializer_list< typename T::value_type > &value, const std::string &doc_string)
RankTwoScalarTools::scalarOptions
MooseEnum scalarOptions()
This enum is left for legacy calls.
Definition: RankTwoScalarTools.C:17
InputParameters::addClassDescription
void addClassDescription(const std::string &doc_string)

Member Data Documentation

◆ _direction

Point LineMaterialRankTwoScalarSampler::_direction
protected

Definition at line 49 of file LineMaterialRankTwoScalarSampler.h.

Referenced by getScalarFromProperty().

◆ _point1

const Point LineMaterialRankTwoScalarSampler::_point1
protected

Definition at line 47 of file LineMaterialRankTwoScalarSampler.h.

Referenced by getScalarFromProperty().

◆ _point2

const Point LineMaterialRankTwoScalarSampler::_point2
protected

Definition at line 48 of file LineMaterialRankTwoScalarSampler.h.

Referenced by getScalarFromProperty().

◆ _scalar_type

MooseEnum LineMaterialRankTwoScalarSampler::_scalar_type
protected

Definition at line 45 of file LineMaterialRankTwoScalarSampler.h.

Referenced by getScalarFromProperty().

The documentation for this class was generated from the following files:
Generated on Tue Apr 15 2025 16:26:34 for https://mooseframework.inl.gov by   doxygen 1.8.14