BVLubby2ModelUpdate

buildconstruction:Undocumented Class

The BVLubby2ModelUpdate 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.

Material for computing a Lubby 2's model viscoelastic update.

Overview

Example Input File Syntax

Input Parameters

  • shear_modulus_kelvinThe Kelvin shear modulus.

    C++ Type:double

    Controllable:No

    Description:The Kelvin shear modulus.

  • viscosity_kelvinThe Kelvin viscosity.

    C++ Type:double

    Controllable:No

    Description:The Kelvin viscosity.

  • viscosity_maxwellThe Maxwell viscosity.

    C++ Type:double

    Controllable:No

    Description:The Maxwell viscosity.

Required Parameters

  • abs_tolerance1e-10The absolute tolerance for the iterative update.

    Default:1e-10

    C++ Type:double

    Controllable:No

    Description:The absolute tolerance for the iterative update.

  • base_nameOptional parameter that defines a prefix for all material properties related to this stress update model. This allows for multiple models of the same type to be used without naming conflicts.

    C++ Type:std::string

    Controllable:No

    Description:Optional parameter that defines a prefix for all material properties related to this stress update model. This allows for multiple models of the same type to be used without naming conflicts.

  • blockThe list of blocks (ids or names) that this object will be applied

    C++ Type:std::vector<SubdomainName>

    Controllable:No

    Description:The list of blocks (ids or names) that this object will be applied

  • boundaryThe list of boundaries (ids or names) from the mesh where this object applies

    C++ Type:std::vector<BoundaryName>

    Controllable:No

    Description:The list of boundaries (ids or names) from the mesh where this object applies

  • constant_onNONEWhen ELEMENT, MOOSE will only call computeQpProperties() for the 0th quadrature point, and then copy that value to the other qps.When SUBDOMAIN, MOOSE will only call computeQpProperties() for the 0th quadrature point, and then copy that value to the other qps. Evaluations on element qps will be skipped

    Default:NONE

    C++ Type:MooseEnum

    Options:NONE, ELEMENT, SUBDOMAIN

    Controllable:No

    Description:When ELEMENT, MOOSE will only call computeQpProperties() for the 0th quadrature point, and then copy that value to the other qps.When SUBDOMAIN, MOOSE will only call computeQpProperties() for the 0th quadrature point, and then copy that value to the other qps. Evaluations on element qps will be skipped

  • declare_suffixAn optional suffix parameter that can be appended to any declared properties. The suffix will be prepended with a '_' character.

    C++ Type:MaterialPropertyName

    Controllable:No

    Description:An optional suffix parameter that can be appended to any declared properties. The suffix will be prepended with a '_' character.

  • m_10The Maxwell stress-dependence parameter.

    Default:0

    C++ Type:double

    Controllable:No

    Description:The Maxwell stress-dependence parameter.

  • m_20The Kelvin viscosity stress-dependence parameter.

    Default:0

    C++ Type:double

    Controllable:No

    Description:The Kelvin viscosity stress-dependence parameter.

  • m_G0The Kelvin elastic modulus stress-dependence parameter.

    Default:0

    C++ Type:double

    Controllable:No

    Description:The Kelvin elastic modulus stress-dependence parameter.

  • max_iterations200The maximum number of iterations for the iterative update

    Default:200

    C++ Type:unsigned int

    Controllable:No

    Description:The maximum number of iterations for the iterative update

  • prop_getter_suffixAn optional suffix parameter that can be appended to any attempt to retrieve/get material properties. The suffix will be prepended with a '_' character.

    C++ Type:MaterialPropertyName

    Controllable:No

    Description:An optional suffix parameter that can be appended to any attempt to retrieve/get material properties. The suffix will be prepended with a '_' character.

  • rel_tolerance1e-10The relative tolerance for the iterative update.

    Default:1e-10

    C++ Type:double

    Controllable:No

    Description:The relative tolerance for the iterative update.

  • sigma_01The reference stress.

    Default:1

    C++ Type:double

    Controllable:No

    Description:The reference stress.

  • use_interpolated_stateFalseFor the old and older state use projected material properties interpolated at the quadrature points. To set up projection use the ProjectedStatefulMaterialStorageAction.

    Default:False

    C++ Type:bool

    Controllable:No

    Description:For the old and older state use projected material properties interpolated at the quadrature points. To set up projection use the ProjectedStatefulMaterialStorageAction.

Optional Parameters

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

    C++ Type:std::vector<std::string>

    Controllable:No

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

  • enableTrueSet the enabled status of the MooseObject.

    Default:True

    C++ Type:bool

    Controllable:Yes

    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

    Controllable:No

    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

    Controllable:No

    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

    Controllable:No

    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

  • output_propertiesList of material properties, from this material, to output (outputs must also be defined to an output type)

    C++ Type:std::vector<std::string>

    Controllable:No

    Description:List of material properties, from this material, to output (outputs must also be defined to an output type)

  • outputsnone Vector of output names where you would like to restrict the output of variables(s) associated with this object

    Default:none

    C++ Type:std::vector<OutputName>

    Controllable:No

    Description:Vector of output names where you would like to restrict the output of variables(s) associated with this object

Outputs Parameters

Input Files