AFMTotalEnergyDensity

Calculates the sum of energy densities

Overview

Computes the sum of the energy densities relevant for the antiferromagnetic (AFM) ferroelectric (i.e. ),

where , , , , and are the short-range superexchange, Dzyaloshinskii–Moriya interaction, easy-plane anisotropy, weak in-plane anisotropy, and long-range AFM exchange.

Example Input File Syntax

Input Parameters

  • Eca1The cubic anisotropy energy density for sublattice 1

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

    Controllable:No

    Description:The cubic anisotropy energy density for sublattice 1

  • Eca2The cubic anisotropy energy density for sublattice 2

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

    Controllable:No

    Description:The cubic anisotropy energy density for sublattice 2

  • EdmiThe DMI energy density

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

    Controllable:No

    Description:The DMI energy density

  • Eepa1The easy-plane anisotropy energy density for sublattice 1

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

    Controllable:No

    Description:The easy-plane anisotropy energy density for sublattice 1

  • Eepa2The easy-plane anisotropy energy density for sublattice 2

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

    Controllable:No

    Description:The easy-plane anisotropy energy density for sublattice 2

  • EnlexchThe non-local exchange stiffness energy density

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

    Controllable:No

    Description:The non-local exchange stiffness energy density

  • EsupexchThe superexchange energy density

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

    Controllable:No

    Description:The superexchange energy density

  • variableThe name of the variable that this object applies to

    C++ Type:AuxVariableName

    Controllable:No

    Description:The name of the variable that this object applies to

Required 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

  • 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

  • check_boundary_restrictedTrueWhether to check for multiple element sides on the boundary in the case of a boundary restricted, element aux variable. Setting this to false will allow contribution to a single element's elemental value(s) from multiple boundary sides on the same element (example: when the restricted boundary exists on two or more sides of an element, such as at a corner of a mesh

    Default:True

    C++ Type:bool

    Controllable:No

    Description:Whether to check for multiple element sides on the boundary in the case of a boundary restricted, element aux variable. Setting this to false will allow contribution to a single element's elemental value(s) from multiple boundary sides on the same element (example: when the restricted boundary exists on two or more sides of an element, such as at a corner of a mesh

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

    Default:LINEAR TIMESTEP_END

    C++ Type:ExecFlagEnum

    Options:NONE, INITIAL, LINEAR, NONLINEAR, TIMESTEP_END, TIMESTEP_BEGIN, MULTIAPP_FIXED_POINT_END, MULTIAPP_FIXED_POINT_BEGIN, FINAL, CUSTOM, ALWAYS, PRE_DISPLACE

    Controllable:No

    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, MULTIAPP_FIXED_POINT_END, MULTIAPP_FIXED_POINT_BEGIN, FINAL, CUSTOM, ALWAYS, PRE_DISPLACE.

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

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.

  • 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