- mag_xThe x component of the magnetization
C++ Type:std::vector<VariableName>
Unit:(no unit assumed)
Controllable:No
Description:The x component of the magnetization
- mag_yThe y component of the magnetization
C++ Type:std::vector<VariableName>
Unit:(no unit assumed)
Controllable:No
Description:The y component of the magnetization
MasterMagneticDMIEnergy
Calculates an integral over the bulk or interfacial Dzyaloshinskii-Moriya energy density of a ferromagnet.
Overview
Computes the free energy of the simulation box (volume ) corresponding to the Dzyaloshinskii-Moriya interaction of a ferromagnet,
selected by dmi_type, with the same sign convention as the kernel MasterDMICartLLG. The units of the energy are given by units of times the mesh volume, and the optional input parameter energyscale converts them (e.g. for a mesh in nm with D supplied as , giving J).
Example Input File Syntax
The DMI class is taken from dmi_type (set in [GlobalParams] in this example):
[Postprocessors<<<{"href": "../../syntax/Postprocessors/index.html"}>>>]
[E_dmi]
type = MasterMagneticDMIEnergy<<<{"description": "Calculates an integral over the bulk or interfacial Dzyaloshinskii-Moriya energy density of a ferromagnet.", "href": "MasterMagneticDMIEnergy.html"}>>>
energy_scale<<<{"description": "the energy scale, useful for transition between eV and aJ"}>>> = 1e-27
[]
[]It enters the total energy with the other terms:
[Postprocessors<<<{"href": "../../syntax/Postprocessors/index.html"}>>>]
[E_total]
type = LinearCombinationPostprocessor<<<{"description": "Computes a linear combination between an arbitrary number of post-processors", "href": "LinearCombinationPostprocessor.html"}>>>
pp_names<<<{"description": "List of post-processors"}>>> = 'E_exchange E_dmi E_anisotropy'
pp_coefs<<<{"description": "List of linear combination coefficients for each post-processor"}>>> = '1 1 1'
[]
[]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
- dmi_typebulkbulk: w = D m.(curl m); interfacial: w = D [mz div(m) - (m.grad) mz], interface normal +z
Default:bulk
C++ Type:MooseEnum
Controllable:No
Description:bulk: w = D m.(curl m); interfacial: w = D [mz div(m) - (m.grad) mz], interface normal +z
- energy_scale1the energy scale, useful for transition between eV and aJ
Default:1
C++ Type:Real
Unit:(no unit assumed)
Controllable:No
Description:the energy scale, useful for transition between eV and aJ
- mag_zThe z component of the magnetization
C++ Type:std::vector<VariableName>
Unit:(no unit assumed)
Controllable:No
Description:The z component of the magnetization
Optional Parameters
- allow_duplicate_execution_on_initialFalseIn the case where this UserObject is depended upon by an initial condition, allow it to be executed twice during the initial setup (once before the IC and again after mesh adaptivity (if applicable).
Default:False
C++ Type:bool
Controllable:No
Description:In the case where this UserObject is depended upon by an initial condition, allow it to be executed twice during the initial setup (once before the IC and again after mesh adaptivity (if applicable).
- execute_onTIMESTEP_ENDThe 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:TIMESTEP_END
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.
- execution_order_group0Execution order groups are executed in increasing order (e.g., the lowest number is executed first). Note that negative group numbers may be used to execute groups before the default (0) group. Please refer to the user object documentation for ordering of user object execution within a group.
Default:0
C++ Type:int
Controllable:No
Description:Execution order groups are executed in increasing order (e.g., the lowest number is executed first). Note that negative group numbers may be used to execute groups before the default (0) group. Please refer to the user object documentation for ordering of user object execution within a group.
- force_postauxFalseForces the UserObject to be executed in POSTAUX
Default:False
C++ Type:bool
Controllable:No
Description:Forces the UserObject to be executed in POSTAUX
- force_preauxFalseForces the UserObject to be executed in PREAUX
Default:False
C++ Type:bool
Controllable:No
Description:Forces the UserObject to be executed in PREAUX
- force_preicFalseForces the UserObject to be executed in PREIC during initial setup
Default:False
C++ Type:bool
Controllable:No
Description:Forces the UserObject to be executed in PREIC during initial setup
Execution Scheduling 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
- outputsVector of output names where you would like to restrict the output of variables(s) associated with this object
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
- 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
- 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
Unit:(no unit assumed)
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.
- 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.