- Hext_xThe fixed x-component of the magnetic field variable
C++ Type:std::vector<VariableName>
Controllable:No
Description:The fixed x-component of the magnetic field variable
- Hext_yThe fixed y-component of the magnetic field variable
C++ Type:std::vector<VariableName>
Controllable:No
Description:The fixed y-component of the magnetic field variable
- Hext_zThe fixed z-component of the magnetic field variable
C++ Type:std::vector<VariableName>
Controllable:No
Description:The fixed z-component of the magnetic field variable
- mag_xThe x component of the constrained magnetization
C++ Type:std::vector<VariableName>
Controllable:No
Description:The x component of the constrained magnetization
- mag_yThe y component of the constrained magnetization
C++ Type:std::vector<VariableName>
Controllable:No
Description:The y component of the constrained magnetization
MasterMagneticZeemanEnergyCart
Calculates a volume integral over the Zeeman interaction energy.
Overview
Computes the free energy in the simulation box (volume ) corresponding to the Zeeman interaction,
where is the normalized magnetization vector, is the saturation magnetization density, is the permeability of vacuum. The applied (external) field is . The units of the energy are given by units of , , and but an optional input parameter flag energyscale is provided allowing to quickly convert the postprocessed units.
Example Input File Syntax
Input Parameters
- Hscale1scale for magnetic field
Default:1
C++ Type:double
Controllable:No
Description:scale for magnetic field
- 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
- energy_scale1the energy scale, useful for transition between eV and J
Default:1
C++ Type:double
Controllable:No
Description:the energy scale, useful for transition between eV and J
- execute_onTIMESTEP_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.
Default:TIMESTEP_END
C++ Type:ExecFlagEnum
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.
- mag_zThe z component of the constrained magnetization
C++ Type:std::vector<VariableName>
Controllable:No
Description:The z component of the constrained magnetization
- mu01permeability of the vacuum
Default:1
C++ Type:double
Controllable:No
Description:permeability of the vacuum
- 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
- 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).
- 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.
- 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
- 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.