package
0.0.0-20240913120853-ab6a133b82ab
Repository: https://github.com/mathieumoalic/amumax.git
Documentation: pkg.go.dev

# Functions

No description provided by the author
Add the anisotropy energy density to dst.
Add the anisotropy field to dst.
Adds the custom energy densities (defined with AddCustomE.
AddCustomField evaluates the user-defined custom field terms and adds the result to dst.
AddEnergyTerm adds an energy density function (returning Joules/m³) to Edens_total.
Adds the current exchange field to dst.
AddFieldTerm adds an effective field function (returning Teslas) to B_eff.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
Adds the current spin transfer torque to dst.
No description provided by the author
AsScalarField promotes a quantity to a ScalarField, enabling convenience methods particular to scalars.
AsVectorField promotes a quantity to a VectorField, enabling convenience methods particular to vectors.
Register quant to be auto-saved every period.
Register quant to be auto-saved as image, every period.
No description provided by the author
No description provided by the author
No description provided by the author
Single cell with given index.
This post-step function centers the simulation window on a bubble.
This post-step function centers the simulation window on a domain wall between up-down (or down-up) domains (like in perpendicular media).
No description provided by the author
No description provided by the author
Cleanly exits the simulation, assuring all output is flushed.
Comp returns vector component c of the parent Quantity.
No description provided by the author
3D Cone with the vertex down.
Conical magnetization configuration.
Const returns a constant (uniform) scalar quantity, that can be used to construct custom field terms.
ConstVector returns a constant (uniform) vector quantity, that can be used to construct custom field terms.
check if mesh is set, otherwise, it creates it.
No description provided by the author
No description provided by the author
Crop quantity to a box enclosing the given region.
No description provided by the author
No description provided by the author
No description provided by the author
CrossProduct creates a new quantity that is the cross product of quantities a and b.
3D Rectangular slab with given sides.
cylinder along z.
Add a constant to the script world.
Add a function to the script world.
Add an LValue to the script world.
Add a read-only variable to the script world.
Hack for fixing the closure caveat: Defines "t", the time variable, handled specially by Fix().
Add a (pointer to) variable to the script world.
Define a region with id (0-255) to be inside the Shape.
No description provided by the author
Diamond with given sides.
Div returns a new quantity that evaluates to the pointwise product a and b.
DotProduct creates a new quantity that is the dot product of quantities a and b.
Download a quantity to host, or just return its data when already on host.
No description provided by the author
Ellipsoid with given diameters.
No description provided by the author
No description provided by the author
No description provided by the author
evaluate code, exit on error (behavior for input files).
Temporary shim to fit Slice into EvalTo.
No description provided by the author
No description provided by the author
Test if have lies within want +/- maxError, and print suited message.
No description provided by the author
No description provided by the author
No description provided by the author
Append msg to file.
No description provided by the author
Returns anisotropy energy in joules.
No description provided by the author
No description provided by the author
Returns the current demag energy in Joules.
No description provided by the author
Returns the current exchange energy in Joules.
Returns magneto-ell energy in joules.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
position of the window lab frame.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
Returns the total energy in J.
No description provided by the author
No description provided by the author
No description provided by the author
Hexagon with given sides.
No description provided by the author
converts cell index to coordinate, internal coordinates.
SetOD sets the output directory where auto-saved files will be stored.
inject code into engine and wait for it to complete.
Sets the DMI interaction between region 1 and 2.
Sets the exchange interaction between region 1 and 2.
checks if a script expression contains t (time).
No description provided by the author
No description provided by the author
No description provided by the author
Cell layers #a (inclusive) up to #b (exclusive).
No description provided by the author
No description provided by the author
No description provided by the author
Masks a quantity with a shape The shape will be only evaluated once on the mesh, and will be re-evaluated after mesh change, because otherwise too slow.
No description provided by the author
No description provided by the author
No description provided by the author
Mul returns a new quantity that evaluates to the pointwise product a and b.
MulMV returns a new Quantity that evaluates to the matrix-vector product (Ax·b, Ay·b, Az·b).
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
NewVectorField constructs an outputable space-dependent scalar quantity whose value is provided by function f.
No description provided by the author
TODO: auto derived.
NewScalarValue constructs an outputable space-independent scalar quantity whose value is provided by function f.
Returns a new new slice (3D array) with given number of components and size.
NewVectorField constructs an outputable space-dependent vector quantity whose value is provided by function f.
No description provided by the author
No description provided by the author
NewVectorValue constructs an outputable space-independent vector quantity whose value is provided by function f.
Normalized returns a quantity that evaluates to the unit vector of q.
No description provided by the author
Register function f to be called after every time step.
No description provided by the author
Random initial magnetization.
Random initial magnetization, generated from random seed.
No description provided by the author
2D Rectangle with given sides.
No description provided by the author
No description provided by the author
Removes all customfields.
For a nanowire magnetized in-plane, with mx = mxLeft on the left end and mx = mxRight on the right end (both -1 or +1), add a B field needed to compensate for the surface charges on the left and right edges.
Rounded Equilateral triangle with given sides.
Run the simulation for a number of seconds.
Runs indefinitely.
Runs as long as condition returns true, saves output.
No description provided by the author
Run the simulation for a number of seconds.
No description provided by the author
Save once, with auto file name.
Save under given file name (transparent async I/O).
Periodically called by run loop to save everything that's needed at this time.
Scales the DMI interaction between region 1 and 2.
Scales the heisenberg exchange interaction between region1 and 2.
We set SetBusy(true) when the simulation is too busy too accept GUI input on Inject channel.
Sets dst to the current demag field.
Sets dst to the current effective field, in Tesla.
No description provided by the author
Sets dst to the current Landau-Lifshitz torque.
No description provided by the author
Sets dst to the full (unnormalized) magnetization in A/m.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
Sets dst to the current total torque.
Set dst to total energy density in J/m3.
No description provided by the author
shift the simulation window over dx cells in X direction.
Shifted returns a new Quantity that evaluates to the original, shifted over dx, dy, dz cells.
No description provided by the author
No description provided by the author
Save image once, with auto file name.
No description provided by the author
2D square with given side.
Squircle creates a 3D rounded rectangle (a generalized squircle) with specified side lengths and thickness.
Run the simulation for a number of steps.
synchronous chunky save.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
Seeds the thermal noise generator.
Equilateral triangle with given sides.
Make a 2-domain configuration with domain wall.
Returns a uniform magnetization state.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
Constructs a vector.
No description provided by the author
No description provided by the author
Make a vortex magnetization with given circulation and core polarization (+1 or -1).
Make a vortex wall configuration.
Wave with given diameters.
All cells with x-coordinate between a and b.
All cells with y-coordinate between a and b.
shift the simulation window over dy cells in Y direction.
All cells with z-coordinate between a and b.

# Constants

Arguments for SetSolver.
Arguments for SetSolver.
Arguments for SetSolver.
No description provided by the author
Arguments for SetSolver.
Arguments for SetSolver.
No description provided by the author
No description provided by the author
Arguments for SetSolver.
expected grains per tile.
maximum number of regions, limited by size of byte.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
Arguments for SetSolver.
No description provided by the author
tile size in grains.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author

# Variables

No description provided by the author
No description provided by the author
TODO: normal func.
No description provided by the author
No description provided by the author
No description provided by the author
Anisotropy variables.
Anisotropy variables.
Anisotropy variables.
No description provided by the author
No description provided by the author
No description provided by the author
Anisotropy variables.
No description provided by the author
Demag variables.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
Thermal effective field (T).
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
Demag accuracy (divide cubes in at most N^3 points).
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
number of dm to keep for convergence check.
time step = dt_si (seconds) *dt_mul, which should be nice float32.
TODO: make more accurate.
No description provided by the author
PMA domain wall tilt assuming straight wall.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
Anisotropy variables.
No description provided by the author
Demag variables.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
Anisotropy variables.
No description provided by the author
Demag variables.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
enable/disable global demag field.
No description provided by the author
Average exchange coupling with neighbors.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
formatting string for auto filenames.
fixed time step?.
No description provided by the author
No description provided by the author
No description provided by the author
1 - frozen, 0 - free.
Gyromagnetic ratio of spins, in rad/Ts.
No description provided by the author
solver headroom, (Gustafsson, 1992, Control of Error and Convergence in ODE Solvers).
injects code in between time steps.
No description provided by the author
No description provided by the author
Anisotropy variables.
Anisotropy variables.
Anisotropy variables.
Anisotropy variables.
Anisotropy variables.
No description provided by the author
error of last step, highest error ever.
maxTorque of last time step.
No description provided by the author
reduced magnetization (unit length).
Demag variables.
No description provided by the author
minimum and maximum time step.
maximum error/step.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
minimum and maximum time step.
No description provided by the author
one week.
No description provided by the author
No description provided by the author
Demag variables.
number of good steps, undone steps.
Demag variables.
number of good steps, undone steps.
number of good steps, undone steps.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
set pause at any time to stop running after the current step.
No description provided by the author
No description provided by the author
No description provided by the author
error of last step, highest error ever.
No description provided by the author
No description provided by the author
Solver globals.
No description provided by the author
No description provided by the author
global regions map.
Stopping relax Maxtorque in T.
No description provided by the author
should shift act on magnetization, geometry, regions?.
should shift act on magnetization, geometry, regions?.
when shifting m, put these value at the left/right edge.
when shifting m, put these value at the left/right edge.
when shifting m, put these value at the left/right edge.
when shifting m, put these value at the left/right edge.
should shift act on magnetization, geometry, regions?.
No description provided by the author
No description provided by the author
user-settable snapshot format.
Solver globals.
No description provided by the author
No description provided by the author
stop minimizer if sampled dm is smaller than this.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
time in seconds.
No description provided by the author
accumulated window shift (X and Y) in meter.
accumulated window shift (X and Y) in meter.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
holds the script state (variables etc).
No description provided by the author

# Structs

Implicit midpoint solver.
No description provided by the author
No description provided by the author
No description provided by the author
parameter derived from others (not directly settable).
No description provided by the author
An excitation, typically field or current, can be defined region-wise plus extra mask*multiplier terms.
No description provided by the author
Adaptive Heun solver.
No description provided by the author
stores the region index for each cell.
specialized param with 1 component.
vector input parameter, settable by user.
No description provided by the author
Bogacki-Shampine solver.
Classical 4th order RK solver.
No description provided by the author
No description provided by the author
An excitation, typically field or current, can be defined region-wise plus extra mask*multiplier terms.
ScalarField enhances an outputField with methods specific to a space-dependent scalar quantity.
ScalarValue enhances an outputValue with methods specific to a space-independent scalar quantity (e.g.
the Table is kept in RAM and used for the API.
VectorField enhances an outputField with methods specific to a space-dependent vector quantity.
VectorValue enhances an outputValue with methods specific to a space-independent vector quantity (e.g.

# Interfaces

The Info interface defines the bare minimum methods a quantity must implement to be accessible for scripting and I/O.
LValue is settable.
Arbitrary physical quantity.
Time stepper like Euler, Heun, RK23.

# Type aliases

Magnetic configuration returns m vector for position (x,y,z).
No description provided by the author
No description provided by the author
geometrical shape for setting sample geometry.
Special error that is not fatal when paniced on and called from GUI E.g.: try to set bad grid size: panic on UserErr, recover, print error, carry on.