FENICS_lumped_impedance_model

class nrv.fmod.FEM.FENICS_lumped_impedance_model(fname=None, Ncore=None, handle_server=False, elem=None, comm='default', rank=0)[source]

A class for FENICS Finite Element Models, inherits from FENICS_model.

Attributes

Methods

FENICS_lumped_impedance_model.__init__([...])

Creates a instance of a FENICS Finite Element Model object.

FENICS_lumped_impedance_model.add_electrode(...)

TO BE WRITTEN

FENICS_lumped_impedance_model.build_and_mesh()

Build the geometry and perform meshing process

FENICS_lumped_impedance_model.get_meshes()

Visualize the model mesh WARNING: debbug use only + might not work on all os

FENICS_lumped_impedance_model.get_parameters()

Get the all the parameters in the model as a python dictionary.

FENICS_lumped_impedance_model.get_potentials(x, y, z)

Get the potential on a line to get extracellular potential for axons stimulation.

FENICS_lumped_impedance_model.get_timers([...])

Returns the timers of each step of the FEM computation

FENICS_lumped_impedance_model.load([data])

Load all extracellular context properties from a dictionary or a json file

FENICS_lumped_impedance_model.load_from_parameters(**param)

FENICS_lumped_impedance_model.remove_fascicles([ID])

remove a fascicle of the FEM simulation

FENICS_lumped_impedance_model.reset_parameters()

reset model parameters

FENICS_lumped_impedance_model.reshape_axon(d)

FENICS_lumped_impedance_model.reshape_fascicle(...)

Reshape a fascicle of the FEM simulation

FENICS_lumped_impedance_model.reshape_nerve([...])

Reshape the nerve of the FEM simulation

FENICS_lumped_impedance_model.reshape_outerBox(Outer_D)

Reshape the size of the FEM simulation outer box

FENICS_lumped_impedance_model.save([save, ...])

Save the changes to the model file.

FENICS_lumped_impedance_model.save_results([...])

Save the changes to the model file.

FENICS_lumped_impedance_model.set_Ncore(N)

Set the number of cores to use for the FEM

FENICS_lumped_impedance_model.set_axon_membrane(...)

FENICS_lumped_impedance_model.set_materials([...])

Set material files for any domain

FENICS_lumped_impedance_model.set_parameters(...)

Generic method to set any attribute of NRV_class instance

FENICS_lumped_impedance_model.setup_simulations([...])

TO BE WRITTEN

FENICS_lumped_impedance_model.solve([comm, rank])

Solve the model