# DerivativeSumMaterial

Meta-material to sum up multiple derivative materials

This material generates new material properties that sum up the values and derivatives of a specified set of function materials. Using args argument the union of all sets of dependent variables has to be specified so that the DerivativeSumMaterial can gather the necessary derivatives to sum up.


[Materials]
# material subblocks that define Fa, Fb, and Fc are omitted

[./free_energy]
type = DerivativeSumMaterial
block = 0
f_name = F
sum_materials = 'Fa Fb Fc'
args = 'c'
outputs = exodus
[../]
[]


## Input Parameters

• argsArguments of the free energy functions being summed - use vector coupling

C++ Type:std::vector

Options:

Description:Arguments of the free energy functions being summed - use vector coupling

### Required Parameters

• computeTrueWhen false, MOOSE will not call compute methods on this material. The user must call computeProperties() after retrieving the Material via MaterialPropertyInterface::getMaterial(). Non-computed Materials are not sorted for dependencies.

Default:True

C++ Type:bool

Options:

Description:When false, MOOSE will not call compute methods on this material. The user must call computeProperties() after retrieving the Material via MaterialPropertyInterface::getMaterial(). Non-computed Materials are not sorted for dependencies.

C++ Type:std::vector

Options:

• f_nameFBase name of the free energy function (used to name the material properties)

Default:F

C++ Type:std::string

Options:

Description:Base name of the free energy function (used to name the material properties)

• sum_materialsBase name of the free energy function (used to name the material properties)

C++ Type:std::vector

Options:

Description:Base name of the free energy function (used to name the material properties)

• derivative_order3Maximum order of derivatives taken (2 or 3)

Default:3

C++ Type:unsigned int

Options:

Description:Maximum order of derivatives taken (2 or 3)

• boundaryThe list of boundary IDs from the mesh where this boundary condition applies

C++ Type:std::vector

Options:

Description:The list of boundary IDs from the mesh where this boundary condition applies

• 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

### Optional Parameters

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

C++ Type:std::vector

Options:

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

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

Default:none

C++ Type:std::vector

Options:

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

### Outputs Parameters

• enableTrueSet the enabled status of the MooseObject.

Default:True

C++ Type:bool

Options:

Description:Set the enabled status of the MooseObject.

• constant0Constant to be added to the prefactor multiplied sum.

Default:0

C++ Type:double

Options:

Description:Constant to be added to the prefactor multiplied sum.

• 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.

• 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.

• seed0The seed for the master random number generator

Default:0

C++ Type:unsigned int

Options:

Description:The seed for the master random number generator

• prefactorPrefactor to multiply the sum term with.

C++ Type:std::vector

Options:

Description:Prefactor to multiply the sum term with.

• 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

• 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 computeSubdomainProperties() 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

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 computeSubdomainProperties() for the 0th quadrature point, and then copy that value to the other qps. Evaluations on element qps will be skipped