# LoadCase package

This module contains functions that define interaction between various parts of the mitotic spindle, create compressive loads and specify boundary conditions as well as formulate the buckling step analysis.

## Submodules

## LoadCase.Interaction module

`LoadCase.Interaction.``CoupleAMTs`(**kwargs)

  Couple astral microtubules with springs

  Parameters: | kwargs – object
  Returns: | None

`LoadCase.Interaction.``CoupleAMTsToCentrosomes`(**kwargs)

  Connect astral microtubules to centrosomes

  Parameters: | kwargs – object
  Returns: | None

`LoadCase.Interaction.``CoupleIpMTsToCentrosomes`(**kwargs)

  Connect and couple interpolar microtubules to centrosomes

  Parameters: | kwargs – object
  Returns: | None

`LoadCase.Interaction.``CoupleIpMTsToSring`(data, **kwargs)

  Create distributed elastic spring and couple interpolar microtubules to it

  Parameters: | kwargs – object
  Returns: | None

`LoadCase.Interaction.``create_interactions`(**kwargs)

  Define all interactions and connections within model

  Parameters: | kwargs – object
  Returns: | kwargs
  Return type: | object
  Returns: | data
  Return type: | list

## LoadCase.InteractionHelpers module

`LoadCase.InteractionHelpers.``attach_spring`(region, dof, name, springType='Ground', **kwargs)

  Defines a spring object that couples two points or a point to the ground

  Parameters: | region (str) – Name of the region to which spring is attached dof (int) – Number of DOF associated with the spring. name (str) – name of the spring connection springType (str) – Type of the spring. Either Ground or Pair kwargs (dict) – model parameters
  Returns: | Null
  Return type: | Null

`LoadCase.InteractionHelpers.``couple_nearest_aMTs`(i, **kwargs)

  Create a spring-based coupling of pairs of astral microtubules

  Parameters: | i (int) – Number of aMT kwargs (dict) – model parameters
  Returns: | Null
  Return type: | Null

`LoadCase.InteractionHelpers.``coupling_constraint`(region1, region2, influenceRadius, couplingType, weightingMethod, name, **kwargs)

  Create a coupling constraint between two regions

  Parameters: | region1 (object) – Master region region2 (object) – Slave region influenceRadius (float) – The influence of the master region will be distributed throughout the subregion in the slave region defined by this radius couplingType – Type of coupling is DISTRIBUTED ot STRUCTURAL weightingMethod (str) – Method of averaging the parameters of the coupling name (str) – Name of the coupling region kwargs (dict) – model parameters
  Returns: | Null
  Return type: | Null

`LoadCase.InteractionHelpers.``create_RP`(**kwargs)

  Create a reference point

  Parameters: | kwargs – object
  Returns: | reference point object

`LoadCase.InteractionHelpers.``find_nearest`(position, regions)

  Find the astral microtubules that have the closest positions

  Parameters: | position (tuple) – (x, y, z) position of the aMT growing end regions (list of objects) – Regions that contain nearest aMT ends
  Returns: | Null
  Return type: | Null

`LoadCase.InteractionHelpers.``pick_region`(verts_index, regionType, collectionName, position, **kwargs)

  Pick a region to assign connection

  Parameters: | regionType – ‘vertice’, ‘edge’, ‘centrosome’ -> defines the type of the picked region collectionName – name of the entity specified by the region position – ‘centrosome-right’, ‘centrosome-left’ -> defines to which pole the region belongs kwargs – object
  Returns: | (object) region

`LoadCase.InteractionHelpers.``sum_regions`(verts_index, regionType, collectionName, separate='True', **kwargs)

  Split a single picked region into a collection of sub-regions

  Parameters: | regionType – ‘vertice’, ‘edge’, ‘centrosome’ -> defines the type of the picked region collectionName – name of the entity specified by the region separate – ‘True’ -> separate combined region into right and left sub-regions kwargs – opbject
  Returns: | either combined_region or combined_region_right and combined_region_left

## LoadCase.LoadsAndBCs module

`LoadCase.LoadsAndBCs.``create_bc`(**kwargs)

  Fix growing ends of aMTs where they are attached to the membrane

  Parameters: | kwargs (dict) – model parameters
  Returns: | Null
  Return type: | Null

`LoadCase.LoadsAndBCs.``create_load`(data, **kwargs)

  Create and apply compressing load at each connection between connectors and ipMTs

  Parameters: | data (list) – list containing all ipMTs and connectors of the model kwargs (dict) – model parameters
  Returns: | Null
  Return type: | Null

## LoadCase.Step module

`LoadCase.Step.``Step`(**kwargs)

  Create buckling analysis and define all the parameters

  Parameters: | kwargs (dict) – model parameters
  Returns: | Null
  Return type: | Null

## Module contents