XFEMMaterialTensorMarkerUserObject

under construction:Undocumented Class

The XFEMMaterialTensorMarkerUserObject has not been documented. The content listed below should be used as a starting point for documenting the class, which includes the typical automatic documentation associated with a MooseObject; however, what is contained is ultimately determined by what is necessary to make the documentation clear for users.


# XFEMMaterialTensorMarkerUserObject

!syntax description /UserObjects/XFEMMaterialTensorMarkerUserObject

## Overview

!! Replace these lines with information regarding the XFEMMaterialTensorMarkerUserObject object.

## Example Input File Syntax

!! Describe and include an example of how to use the XFEMMaterialTensorMarkerUserObject object.

!syntax parameters /UserObjects/XFEMMaterialTensorMarkerUserObject

!syntax inputs /UserObjects/XFEMMaterialTensorMarkerUserObject

!syntax children /UserObjects/XFEMMaterialTensorMarkerUserObject

!syntax description /UserObjects/XFEMMaterialTensorMarkerUserObject

Input Parameters

  • averageFalseShould the tensor quantity be averaged over the quadruature points?

    Default:False

    C++ Type:bool

    Options:

    Description:Should the tensor quantity be averaged over the quadruature points?

  • tensorThe material tensor name.

    C++ Type:std::string

    Options:

    Description:The material tensor name.

  • thresholdThe threshold for crack growth.

    C++ Type:double

    Options:

    Description:The threshold for crack growth.

Required Parameters

  • blockThe list of block ids (SubdomainID) that this object will be applied

    C++ Type:std::vector

    Options:

    Description:The list of block ids (SubdomainID) that this object will be applied

  • direction1 0 0Direction vector

    Default:1 0 0

    C++ Type:libMesh::VectorValue

    Options:

    Description:Direction vector

  • execute_onTIMESTEP_ENDThe list of flag(s) indicating when this object should be executed, the available options include NONE, INITIAL, LINEAR, NONLINEAR, TIMESTEP_END, TIMESTEP_BEGIN, FINAL, CUSTOM.

    Default:TIMESTEP_END

    C++ Type:ExecFlagEnum

    Options:NONE INITIAL LINEAR NONLINEAR TIMESTEP_END TIMESTEP_BEGIN FINAL CUSTOM

    Description:The list of flag(s) indicating when this object should be executed, the available options include NONE, INITIAL, LINEAR, NONLINEAR, TIMESTEP_END, TIMESTEP_BEGIN, FINAL, CUSTOM.

  • index-1The index into the tensor, from 0 to 5 (xx, yy, zz, xy, yz, zx).

    Default:-1

    C++ Type:int

    Options:

    Description:The index into the tensor, from 0 to 5 (xx, yy, zz, xy, yz, zx).

  • initiate_on_boundaryPermit cracks to initiate in elements adjacent to specified boundaries

    C++ Type:std::vector

    Options:

    Description:Permit cracks to initiate in elements adjacent to specified boundaries

  • point10 0 0Start point for axis used to calculate some material tensor quantities

    Default:0 0 0

    C++ Type:libMesh::VectorValue

    Options:

    Description:Start point for axis used to calculate some material tensor quantities

  • point20 1 0End point for axis used to calculate some material tensor quantities

    Default:0 1 0

    C++ Type:libMesh::VectorValue

    Options:

    Description:End point for axis used to calculate some material tensor quantities

  • quantityA scalar quantity to compute: VonMises EffectiveStrain Hydrostatic Direction Hoop Radial Axial MaxPrincipal MedPrincipal MinPrincipal FirstInvariant SecondInvariant ThirdInvariant TriAxiality VolumetricStrain

    C++ Type:MooseEnum

    Options:VonMises EffectiveStrain Hydrostatic Direction Hoop Radial Axial MaxPrincipal MedPrincipal MinPrincipal FirstInvariant SecondInvariant ThirdInvariant TriAxiality VolumetricStrain

    Description:A scalar quantity to compute: VonMises EffectiveStrain Hydrostatic Direction Hoop Radial Axial MaxPrincipal MedPrincipal MinPrincipal FirstInvariant SecondInvariant ThirdInvariant TriAxiality VolumetricStrain

  • random_range0Range of a uniform random distribution for the threshold

    Default:0

    C++ Type:double

    Options:

    Description:Range of a uniform random distribution for the threshold

  • secondary_cracksFalseshould secondary cracks be allowed

    Default:False

    C++ Type:bool

    Options:

    Description:should secondary cracks be allowed

Optional Parameters

  • allow_duplicate_execution_on_initialFalseIn the case where this UserObject is depended upon by an initial condition, allow it to be executed twice during the initial setup (once before the IC and again after mesh adaptivity (if applicable).

    Default:False

    C++ Type:bool

    Options:

    Description:In the case where this UserObject is depended upon by an initial condition, allow it to be executed twice during the initial setup (once before the IC and again after mesh adaptivity (if applicable).

  • control_tagsAdds user-defined labels for accessing object parameters via control logic.

    C++ Type:std::vector

    Options:

    Description:Adds user-defined labels for accessing object parameters via control logic.

  • enableTrueSet the enabled status of the MooseObject.

    Default:True

    C++ Type:bool

    Options:

    Description:Set the enabled status of the MooseObject.

  • implicitTrueDetermines whether this object is calculated using an implicit or explicit form

    Default:True

    C++ Type:bool

    Options:

    Description:Determines whether this object is calculated using an implicit or explicit form

  • seed0The seed for the master random number generator

    Default:0

    C++ Type:unsigned int

    Options:

    Description:The seed for the master random number generator

  • use_displaced_meshFalseWhether or not this object should use the displaced mesh for computation. Note that in the case this is true but no displacements are provided in the Mesh block the undisplaced mesh will still be used.

    Default:False

    C++ Type:bool

    Options:

    Description:Whether or not this object should use the displaced mesh for computation. Note that in the case this is true but no displacements are provided in the Mesh block the undisplaced mesh will still be used.

Advanced Parameters

Input Files