LLGB

LLGBJunction

LLGB Junction class.

Source code in cmtj/llgb/__init__.pyi

class LLGBJunction:
    """LLGB Junction class."""

    def __init__(self, layers: list[LLGBLayer]) -> None:
        """Initialises a LLGB junction with layers.
        :param layers: list of LLGB layers."""
        ...

    def clearLog(self) -> None:
        """Clears the simulation log of the junction."""
        ...

    def getLog(self) -> dict[str, list[float]]:
        """Returns the simulation log of the junction."""
        ...

    def runSimulation(
        self,
        totalTime: float,
        timeStep: float = ...,
        writeFrequency: float = ...,
        log: bool = ...,
        solverMode: cmtj.SolverMode = ...,
    ) -> None:
        """Runs the simulation of the junction.
        :param totalTime: total simulation time.
        :param timeStep: time step.
        :param writeFrequency: frequency of writing to the log.
        :param log: whether to log the simulation.
        :param solverMode: solver mode.
        """
        ...

    def saveLogs(self, arg0: str) -> None:
        """Saves the simulation logs to a file.
        :param arg0: file path."""
        ...

    def setLayerExternalFieldDriver(self, layerId: str, driver: cmtj.AxialDriver) -> None:
        """Set an external field driver for a layer.
        :param layerId: the id of the layer.
        :param driver: the field driver to be set."""
        ...

    def setLayerTemperatureDriver(self, layerId: str, driver: cmtj.ScalarDriver) -> None:
        """Set a temperature driver for a layer.
        :param layerId: the id of the layer.
        :param driver: the temperature driver to be set.
        """
        ...

__init__(layers)

Initialises a LLGB junction with layers.

Parameters:

Name	Type	Description	Default
layers	list[LLGBLayer]	list of LLGB layers.	required

Source code in cmtj/llgb/__init__.pyi

def __init__(self, layers: list[LLGBLayer]) -> None:
    """Initialises a LLGB junction with layers.
    :param layers: list of LLGB layers."""
    ...

clearLog()

Clears the simulation log of the junction.

Source code in cmtj/llgb/__init__.pyi

def clearLog(self) -> None:
    """Clears the simulation log of the junction."""
    ...

getLog()

Returns the simulation log of the junction.

Source code in cmtj/llgb/__init__.pyi

def getLog(self) -> dict[str, list[float]]:
    """Returns the simulation log of the junction."""
    ...

runSimulation(totalTime, timeStep=Ellipsis, writeFrequency=Ellipsis, log=Ellipsis, solverMode=Ellipsis)

Runs the simulation of the junction.

Parameters:

Name	Type	Description	Default
totalTime	float	total simulation time.	required
timeStep	float	time step.	Ellipsis
writeFrequency	float	frequency of writing to the log.	Ellipsis
log	bool	whether to log the simulation.	Ellipsis
solverMode	cmtj.SolverMode	solver mode.	Ellipsis

Source code in cmtj/llgb/__init__.pyi

def runSimulation(
    self,
    totalTime: float,
    timeStep: float = ...,
    writeFrequency: float = ...,
    log: bool = ...,
    solverMode: cmtj.SolverMode = ...,
) -> None:
    """Runs the simulation of the junction.
    :param totalTime: total simulation time.
    :param timeStep: time step.
    :param writeFrequency: frequency of writing to the log.
    :param log: whether to log the simulation.
    :param solverMode: solver mode.
    """
    ...

saveLogs(arg0)

Saves the simulation logs to a file.

Parameters:

Name	Type	Description	Default
arg0	str	file path.	required

Source code in cmtj/llgb/__init__.pyi

def saveLogs(self, arg0: str) -> None:
    """Saves the simulation logs to a file.
    :param arg0: file path."""
    ...

setLayerExternalFieldDriver(layerId, driver)

Set an external field driver for a layer.

Parameters:

Name	Type	Description	Default
layerId	str	the id of the layer.	required
driver	cmtj.AxialDriver	the field driver to be set.	required

Source code in cmtj/llgb/__init__.pyi

def setLayerExternalFieldDriver(self, layerId: str, driver: cmtj.AxialDriver) -> None:
    """Set an external field driver for a layer.
    :param layerId: the id of the layer.
    :param driver: the field driver to be set."""
    ...

setLayerTemperatureDriver(layerId, driver)

Set a temperature driver for a layer.

Parameters:

Name	Type	Description	Default
layerId	str	the id of the layer.	required
driver	cmtj.ScalarDriver	the temperature driver to be set.	required

Source code in cmtj/llgb/__init__.pyi

def setLayerTemperatureDriver(self, layerId: str, driver: cmtj.ScalarDriver) -> None:
    """Set a temperature driver for a layer.
    :param layerId: the id of the layer.
    :param driver: the temperature driver to be set.
    """
    ...

LLGBLayer

LLGB Layer class.

Source code in cmtj/llgb/__init__.pyi

class LLGBLayer:
    """LLGB Layer class."""

    def __init__(
        self,
        id: str,
        mag: cmtj.CVector,
        anis: cmtj.CVector,
        Ms: float,
        thickness: float,
        cellSurface: float,
        demagTensor: list[cmtj.CVector],
        damping: float,
        Tc: float,
        susceptibility: float,
        me: float,
    ) -> None:
        """Creates a LLGB layer.
        :param id: layer id.
        :param mag: magnetisation.
        :param anis: anisotropy axis.
        :param Ms: saturation magnetisation.
        :param thickness: thickness.
        :param cellSurface: cell surface.
        :param demagTensor: demagnetisation tensor.
        :param damping: damping factor.
        :param Tc: Curie temperature.
        :param susceptibility: susceptibility.
        :param me: equilibrium magnetisation.
        """
        ...

    def setAnisotropyDriver(self, driver: cmtj.ScalarDriver) -> None:
        """Sets an anisotropy driver.
        :param driver: the anisotropy driver to be set."""
        ...

    def setExternalFieldDriver(self, driver: cmtj.AxialDriver) -> None:
        """Sets an external field driver.
        :param driver: the field driver to be set."""
        ...

    def setTemperatureDriver(self, driver: cmtj.ScalarDriver) -> None:
        """Sets a temperature driver.
        :param driver: the temperature driver to be set."""
        ...

__init__(id, mag, anis, Ms, thickness, cellSurface, demagTensor, damping, Tc, susceptibility, me)

Creates a LLGB layer.

Parameters:

Name	Type	Description	Default
id	str	layer id.	required
mag	cmtj.CVector	magnetisation.	required
anis	cmtj.CVector	anisotropy axis.	required
Ms	float	saturation magnetisation.	required
thickness	float	thickness.	required
cellSurface	float	cell surface.	required
demagTensor	list[cmtj.CVector]	demagnetisation tensor.	required
damping	float	damping factor.	required
Tc	float	Curie temperature.	required
susceptibility	float	susceptibility.	required
me	float	equilibrium magnetisation.	required

Source code in cmtj/llgb/__init__.pyi

def __init__(
    self,
    id: str,
    mag: cmtj.CVector,
    anis: cmtj.CVector,
    Ms: float,
    thickness: float,
    cellSurface: float,
    demagTensor: list[cmtj.CVector],
    damping: float,
    Tc: float,
    susceptibility: float,
    me: float,
) -> None:
    """Creates a LLGB layer.
    :param id: layer id.
    :param mag: magnetisation.
    :param anis: anisotropy axis.
    :param Ms: saturation magnetisation.
    :param thickness: thickness.
    :param cellSurface: cell surface.
    :param demagTensor: demagnetisation tensor.
    :param damping: damping factor.
    :param Tc: Curie temperature.
    :param susceptibility: susceptibility.
    :param me: equilibrium magnetisation.
    """
    ...

setAnisotropyDriver(driver)

Sets an anisotropy driver.

Parameters:

Name	Type	Description	Default
driver	cmtj.ScalarDriver	the anisotropy driver to be set.	required

Source code in cmtj/llgb/__init__.pyi

def setAnisotropyDriver(self, driver: cmtj.ScalarDriver) -> None:
    """Sets an anisotropy driver.
    :param driver: the anisotropy driver to be set."""
    ...

setExternalFieldDriver(driver)

Sets an external field driver.

Parameters:

Name	Type	Description	Default
driver	cmtj.AxialDriver	the field driver to be set.	required

Source code in cmtj/llgb/__init__.pyi

def setExternalFieldDriver(self, driver: cmtj.AxialDriver) -> None:
    """Sets an external field driver.
    :param driver: the field driver to be set."""
    ...

setTemperatureDriver(driver)

Sets a temperature driver.

Parameters:

Name	Type	Description	Default
driver	cmtj.ScalarDriver	the temperature driver to be set.	required

Source code in cmtj/llgb/__init__.pyi

def setTemperatureDriver(self, driver: cmtj.ScalarDriver) -> None:
    """Sets a temperature driver.
    :param driver: the temperature driver to be set."""
    ...

MFAWeissCurie(me, T, J0, relax=Ellipsis, tolerance=Ellipsis, maxIter=Ellipsis)

Mean Field Approximation for Weiss Curie temperature.

Parameters:

Name	Type	Description	Default
me	float	equilibrium magnetisation.	required
T	float	temperature.	required
J0	float	exchange coupling.	required
relax	float	relaxation factor.	Ellipsis
tolerance	float	tolerance for convergence.	Ellipsis
maxIter	int	maximum number of iterations.	Ellipsis

Source code in cmtj/llgb/__init__.pyi

def MFAWeissCurie(
    me: float,
    T: float,
    J0: float,
    relax: float = ...,
    tolerance: float = ...,
    maxIter: int = ...,
) -> tuple[float, float]:
    """Mean Field Approximation for Weiss Curie temperature.
    :param me: equilibrium magnetisation.
    :param T: temperature.
    :param J0: exchange coupling.
    :param relax: relaxation factor.
    :param tolerance: tolerance for convergence.
    :param maxIter: maximum number of iterations."""
    ...