ScalarElasticEnergy

Overview

Sets up the RHS of the coupled Landau-Khalatnikov equation. Since we are working with ScalarKernels, this is effectively a single grid point, or homogeneous calculation. In the context of micromagnetics, this is the macrospin analog for ferroelectrics. This object concerns the elastic energy contribution from the spontaneous strains (in the case of ),

Ignoring the LHS and working in index notation,

In Voight notation, many of these terms vanish due to symmetry of the parent phase. The tensor is the elastic stiffness matrix. Note that as opposed to a spatially dependent calculation, the strain tensor is assumed to be constant in space. This leads to our approximation that is a variable in this calculation as opposed to a postprocessed quantity depending on the elastic displacement vector .

Example Input File Syntax

Input Parameters

  • componentAn integer corresponding to the direction the variable this kernel acts in. (0 for xx, 1 for yy, 2 for zz, 3 for xy, 4 for yz, 5 for zx)

    C++ Type:unsigned int

    Controllable:No

    Description:An integer corresponding to the direction the variable this kernel acts in. (0 for xx, 1 for yy, 2 for zz, 3 for xy, 4 for yz, 5 for zx)

  • variableThe name of the variable that this residual object operates on

    C++ Type:NonlinearVariableName

    Controllable:No

    Description:The name of the variable that this residual object operates on

Required Parameters

  • C111the first coefficient

    Default:1

    C++ Type:double

    Controllable:No

    Description:the first coefficient

  • C121the second coefficient

    Default:1

    C++ Type:double

    Controllable:No

    Description:the second coefficient

  • C441the third coefficient

    Default:1

    C++ Type:double

    Controllable:No

    Description:the third coefficient

  • G1the time constant

    Default:1

    C++ Type:double

    Controllable:No

    Description:the time constant

  • e_xxvariable e_xx coupled into this kernel

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

    Controllable:No

    Description:variable e_xx coupled into this kernel

  • e_xyvariable e_xy coupled into this kernel

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

    Controllable:No

    Description:variable e_xy coupled into this kernel

  • e_yyvariable e_yy coupled into this kernel

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

    Controllable:No

    Description:variable e_yy coupled into this kernel

  • e_yzvariable e_yz coupled into this kernel

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

    Controllable:No

    Description:variable e_yz coupled into this kernel

  • e_zxvariable e_zx coupled into this kernel

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

    Controllable:No

    Description:variable e_zx coupled into this kernel

  • e_zzvariable e_zz coupled into this kernel

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

    Controllable:No

    Description:variable e_zz coupled into this kernel

Optional Parameters

  • absolute_value_vector_tagsThe tags for the vectors this residual object should fill with the absolute value of the residual contribution

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

    Controllable:No

    Description:The tags for the vectors this residual object should fill with the absolute value of the residual contribution

  • extra_matrix_tagsThe extra tags for the matrices this Kernel should fill

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

    Controllable:No

    Description:The extra tags for the matrices this Kernel should fill

  • extra_vector_tagsThe extra tags for the vectors this Kernel should fill

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

    Controllable:No

    Description:The extra tags for the vectors this Kernel should fill

  • matrix_tagssystemThe tag for the matrices this Kernel should fill

    Default:system

    C++ Type:MultiMooseEnum

    Options:nontime, system

    Controllable:No

    Description:The tag for the matrices this Kernel should fill

  • vector_tagsnontimeThe tag for the vectors this Kernel should fill

    Default:nontime

    C++ Type:MultiMooseEnum

    Options:nontime, time

    Controllable:No

    Description:The tag for the vectors this Kernel should fill

Tagging 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

Input Files