- prop_nameThe name of the property to declare. A functor is any of the following: a variable, a functor material property, a function, a post-processor, or a number.
C++ Type:MooseFunctorName
Unit:(no unit assumed)
Controllable:No
Description:The name of the property to declare. A functor is any of the following: a variable, a functor material property, a function, a post-processor, or a number.
- subdomain_to_prop_valueMap from subdomain to property value. The value may be a constant or any kind of functor (functions, variables, functor material properties)
C++ Type:std::map<std::string,std::string, std::less<std::string>, std::allocator<std::pair<std::stringconst,std::string>>>
Controllable:No
Description:Map from subdomain to property value. The value may be a constant or any kind of functor (functions, variables, functor material properties)
PiecewiseByBlockVectorFunctorMaterial ADPiecewiseByBlockVectorFunctorMaterial
Computes a property value on a per-subdomain basis
Overview
This object is useful for providing a material property vector value that is discontinuous from subdomain to subdomain. "prop_name" is required to specify the name of the material vector property. The map parameter "subdomain_to_prop_value" is used for specifying the property vector value on a subdomain name basis; the first member of each pair should be a subdomain name while the second member should be a vector functor.
commentnote
ADPiecewiseByBlockVectorFunctorMaterial is the version of this object with automatic differentiation. AD vector functors must be specified as the values on each block.
Input Parameters
- 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
- declare_suffixAn optional suffix parameter that can be appended to any declared properties. The suffix will be prepended with a '_' character.
C++ Type:MaterialPropertyName
Unit:(no unit assumed)
Controllable:No
Description:An optional suffix parameter that can be appended to any declared properties. The suffix will be prepended with a '_' character.
- execute_onALWAYSThe list of flag(s) indicating when this object should be executed. For a description of each flag, see https://mooseframework.inl.gov/source/interfaces/SetupInterface.html.
Default:ALWAYS
C++ Type:ExecFlagEnum
Controllable:No
Description:The list of flag(s) indicating when this object should be executed. For a description of each flag, see https://mooseframework.inl.gov/source/interfaces/SetupInterface.html.
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
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