elements

Dynamical

class for modeling a dynamical system

Source code in batterylearn/elements/elements.py

class Dynamical:
    """class for modeling a dynamical system
    """
    def __init__(self, dimension: int = None, x0=None):
        if x0:
            self.x = x0
            self.dim = len(x0)
        elif dimension and dimension > 0:
            self.x = np.zeros((dimension,))
            self.dim = dimension

    @abstractmethod
    def ode(self, **kwargs):
        """the ordinary differential equation that describes system dynamics
        """
        pass

    @abstractmethod
    def out(self, **kwargs):
        pass

    def update(self, x):
        self.x = x

ode(**kwargs) abstractmethod

the ordinary differential equation that describes system dynamics

Source code in batterylearn/elements/elements.py

@abstractmethod
def ode(self, **kwargs):
    """the ordinary differential equation that describes system dynamics
    """
    pass

LinearMechanical

Bases: LinearTimeInvariant

The linear mechanical system, which uses KCM parameters

Parameters:

Name	Type	Description	Default
K	np.array	stiffness array	required
C	np.array	damping array	required
M	np.array	mass/inertia array	required
x0	np.array	initial conditons. Defaults to None.	None

Source code in batterylearn/elements/elements.py

class LinearMechanical(LinearTimeInvariant):

    """The linear mechanical system, which uses KCM parameters 

    Args:
        K (np.array): stiffness array
        C (np.array): damping array
        M (np.array): mass/inertia array
        x0 (np.array, optional): initial conditons. Defaults to None.
    """

    def __init__(self, K:np.array, C:np.array, M:np.array, x0:np.array=None):
        if K.shape != C.shape or K.shape != M.shape:
            ValueError(
                "the input K-C-M parameters should have the same dimension"
            )
        else:
            self.K = K
            self.C = C
            self.M = M

            Eye = np.diag([1] * 5)
            A = np.zeros((10, 10))
            A[:5, :5] = self.C
            A[5:, :5] = self.M
            A[:5, 5:] = Eye

            B = np.zeros((10, 10))
            B[:5, :5] = self.K
            B[5:, 5:] = -Eye

        super().__init__(A=A, B=B)

LinearTimeInvariant

Bases: Dynamical

linear system

Parameters:

Name	Type	Description	Default
A	np.matrix	description	required
B	np.array	description	required
C	np.array	description. Defaults to None.	None
D	np.array	description. Defaults to None.	None
x0	np.array	description. Defaults to None.	None

Source code in batterylearn/elements/elements.py

class LinearTimeInvariant(Dynamical):
    """linear system

    Args:
        A (np.matrix): _description_ 
        B (np.array): _description_
        C (np.array, optional): _description_. Defaults to None.
        D (np.array, optional): _description_. Defaults to None.
        x0 (np.array, optional): _description_. Defaults to None.
    """
    def __init__(self, A:np.matrix, B:np.array, C:np.array=None, D:np.array=None, x0:np.array=None):

        self.A = A
        self.B = B
        self.C = C
        self.D = D
        super(LinearTimeInvariant, self).__init__(len(A), x0)

    def ode(self, **kwargs):
        dx = -np.linalg.inv(self.A).dot(self.B.dot(self.x))

        return dx

    def out(self, **kwargs):
        dx = self.C.dot(self.x)

        return dx

Mechanical

Bases: Dynamical

The mechanical system, which uses KCM (genertic, nonlinear) parameters

Parameters:

Name	Type	Description	Default
K	np.array	stiffness array	required
C	np.array	damping array	required
M	np.array	mass/inertia array	required
x0	np.array	initial conditons. Defaults to None.	None

Source code in batterylearn/elements/elements.py

class Mechanical(Dynamical):

    """The mechanical system, which uses KCM (genertic, nonlinear) parameters 

    Args:
        K (np.array): stiffness array
        C (np.array): damping array
        M (np.array): mass/inertia array
        x0 (np.array, optional): initial conditons. Defaults to None.
    """

    def __init__(self, K, C, M, x0=None):

        if K.shape != C.shape or K.shape != M.shape:
            ValueError(
                "the input K-C-M parameters should have the same dimension"
            )
        else:
            self.K = K
            self.C = C
            self.M = M

        super().__init__(dimension=2 * len(K), x0=x0)

    def ode(self, **kwargs):
        pass

    def out(self, **kwargs):
        pass