carputils.forcepss.planio Namespace Reference

Classes
class	j2cKey
class	j2cError

Functions
def	private_key (key)
def	remove_entries_from_dict (dobj, *args, make_copy=False)
def	load_dict_from_json (file_name, verbose=False)
def	get_dict_from_obj (obj, verbose=False)
def	configurations_section_from_dict_v1 (confs, verbose=False)
def	configurations_section_to_dict_v1 (confs, verbose=False)
def	functions_section_from_dict_v1 (funcs, verbose=False)
def	functions_section_to_dict_v1 (funcs, verbose=False)
def	electrodes_section_from_dict_v1 (elecs, verbose=False)
def	electrodes_section_to_dict_v1 (elecs, verbose=False)
def	solver_section_from_dict_v1 (solver, verbose=False)
def	solver_section_to_dict_v1 (solver, verbose=False)
def	simulation_section_from_dict_v1 (simulation, verbose=False)
def	simulation_section_to_dict_v1 (simulation, verbose=False)
def	protocols_section_from_dict_v1 (protocols, verbose=False)
def	protocols_section_to_dict_v1 (protocols, verbose=False)
def	splitting_section_from_dict_v1 (splitting, verbose=False)
def	splitting_section_to_dict_v1 (splitting, verbose=False)
def	configurations_section_from_dict_v2 (confs, verbose=False)
def	configurations_section_to_dict_v2 (confs, verbose=False)
def	functions_section_from_dict_v2 (funcs, verbose=False)
def	functions_section_to_dict_v2 (funcs, verbose=False, tuning_dir=None)
def	electrodes_section_from_dict_v2 (elecs, verbose=False)
def	electrodes_section_to_dict_v2 (elecs, verbose=False)
def	solver_section_from_dict_v2 (solver, verbose=False)
def	solver_section_to_dict_v2 (solver, verbose=False)
def	simulation_section_from_dict_v2 (simulation, verbose=False)
def	simulation_section_to_dict_v2 (simulation, verbose=False)
def	protocols_section_from_dict_v2 (protocols, verbose=False)
def	protocols_section_to_dict_v2 (protocols, verbose=False)
def	splitting_section_from_dict_v2 (splitting, verbose=False)
def	splitting_section_to_dict_v2 (splitting, verbose=False)
def	get_configurations_section (confs_obj, verbose=False)
def	get_functions_section (funcs_obj, verbose=False)
def	get_electrodes_section (elecs_obj, verbose=False)
def	get_solver_setup_section (solver_obj, verbose=False)
def	get_simulation_setups_section (simulation_obj, verbose=False)
def	get_protocols_section (protocols_obj, verbose=False)
def	get_splitting_section (splitting_obj, verbose=False)
def	load_simulation_plan (plan_file, confs_file=None, funcs_file=None, elecs_file=None, protocols_file=None, simulations_file=None, update_confs=True, update_funcs=True, update_elecs=True, update_protocols=True, update_simulations=True, verbose=False)
def	save_simulation_plan (plan, file_name, indent=2, verbose=False, overwrite=True)

Variables
string	DEFAULT_TUNING_DIR = './init'
tuple	ACTIVE_FUNCTION_COND_NAMES = ('gil', 'git', 'gin', 'gel', 'get', 'gen')
tuple	ACTIVE_FUNCTION_CV_NAMES = ('vf', 'vs', 'vn')
dictionary	DEFAULT_VERSIONS
dictionary	DEFAULT_SOLVER

Function Documentation

configurations_section_from_dict_v1()

def carputils.forcepss.planio.configurations_section_from_dict_v1	(		confs,
			verbose = False
	)

configurations_section_from_dict_v2()

def carputils.forcepss.planio.configurations_section_from_dict_v2	(		confs,
			verbose = False
	)

configurations_section_to_dict_v1()

def carputils.forcepss.planio.configurations_section_to_dict_v1	(		confs,
			verbose = False
	)

configurations_section_to_dict_v2()

def carputils.forcepss.planio.configurations_section_to_dict_v2	(		confs,
			verbose = False
	)

electrodes_section_from_dict_v1()

def carputils.forcepss.planio.electrodes_section_from_dict_v1	(		elecs,
			verbose = False
	)

electrodes_section_from_dict_v2()

def carputils.forcepss.planio.electrodes_section_from_dict_v2	(		elecs,
			verbose = False
	)

electrodes_section_to_dict_v1()

def carputils.forcepss.planio.electrodes_section_to_dict_v1	(		elecs,
			verbose = False
	)

electrodes_section_to_dict_v2()

def carputils.forcepss.planio.electrodes_section_to_dict_v2	(		elecs,
			verbose = False
	)

functions_section_from_dict_v1()

def carputils.forcepss.planio.functions_section_from_dict_v1	(		funcs,
			verbose = False
	)

functions_section_from_dict_v2()

def carputils.forcepss.planio.functions_section_from_dict_v2	(		funcs,
			verbose = False
	)

functions_section_to_dict_v1()

def carputils.forcepss.planio.functions_section_to_dict_v1	(		funcs,
			verbose = False
	)

functions_section_to_dict_v2()

def carputils.forcepss.planio.functions_section_to_dict_v2	(		funcs,
			verbose = False,
			tuning_dir = None
	)

get_configurations_section()

def carputils.forcepss.planio.get_configurations_section	(		confs_obj,
			verbose = False
	)

get_dict_from_obj()

def carputils.forcepss.planio.get_dict_from_obj	(		obj,
			verbose = False
	)

get_electrodes_section()

def carputils.forcepss.planio.get_electrodes_section	(		elecs_obj,
			verbose = False
	)

get_functions_section()

def carputils.forcepss.planio.get_functions_section	(		funcs_obj,
			verbose = False
	)

get_protocols_section()

def carputils.forcepss.planio.get_protocols_section	(		protocols_obj,
			verbose = False
	)

get_simulation_setups_section()

def carputils.forcepss.planio.get_simulation_setups_section	(		simulation_obj,
			verbose = False
	)

get_solver_setup_section()

def carputils.forcepss.planio.get_solver_setup_section	(		solver_obj,
			verbose = False
	)

get_splitting_section()

def carputils.forcepss.planio.get_splitting_section	(		splitting_obj,
			verbose = False
	)

load_dict_from_json()

def carputils.forcepss.planio.load_dict_from_json	(		file_name,
			verbose = False
	)

load_simulation_plan()

def carputils.forcepss.planio.load_simulation_plan	(		plan_file,
			confs_file = None,
			funcs_file = None,
			elecs_file = None,
			protocols_file = None,
			simulations_file = None,
			update_confs = True,
			update_funcs = True,
			update_elecs = True,
			update_protocols = True,
			update_simulations = True,
			verbose = False
	)

private_key()

def carputils.forcepss.planio.private_key

(

key

)

protocols_section_from_dict_v1()

def carputils.forcepss.planio.protocols_section_from_dict_v1	(		protocols,
			verbose = False
	)

protocols_section_from_dict_v2()

def carputils.forcepss.planio.protocols_section_from_dict_v2	(		protocols,
			verbose = False
	)

protocols_section_to_dict_v1()

def carputils.forcepss.planio.protocols_section_to_dict_v1	(		protocols,
			verbose = False
	)

protocols_section_to_dict_v2()

def carputils.forcepss.planio.protocols_section_to_dict_v2	(		protocols,
			verbose = False
	)

remove_entries_from_dict()

def carputils.forcepss.planio.remove_entries_from_dict	(		dobj,
		*	args,
			make_copy = False
	)

save_simulation_plan()

def carputils.forcepss.planio.save_simulation_plan	(		plan,
			file_name,
			indent = 2,
			verbose = False,
			overwrite = True
	)

simulation_section_from_dict_v1()

def carputils.forcepss.planio.simulation_section_from_dict_v1	(		simulation,
			verbose = False
	)

simulation_section_from_dict_v2()

def carputils.forcepss.planio.simulation_section_from_dict_v2	(		simulation,
			verbose = False
	)

simulation_section_to_dict_v1()

def carputils.forcepss.planio.simulation_section_to_dict_v1	(		simulation,
			verbose = False
	)

simulation_section_to_dict_v2()

def carputils.forcepss.planio.simulation_section_to_dict_v2	(		simulation,
			verbose = False
	)

solver_section_from_dict_v1()

def carputils.forcepss.planio.solver_section_from_dict_v1	(		solver,
			verbose = False
	)

solver_section_from_dict_v2()

def carputils.forcepss.planio.solver_section_from_dict_v2	(		solver,
			verbose = False
	)

solver_section_to_dict_v1()

def carputils.forcepss.planio.solver_section_to_dict_v1	(		solver,
			verbose = False
	)

solver_section_to_dict_v2()

def carputils.forcepss.planio.solver_section_to_dict_v2	(		solver,
			verbose = False
	)

splitting_section_from_dict_v1()

def carputils.forcepss.planio.splitting_section_from_dict_v1	(		splitting,
			verbose = False
	)

splitting_section_from_dict_v2()

def carputils.forcepss.planio.splitting_section_from_dict_v2	(		splitting,
			verbose = False
	)

splitting_section_to_dict_v1()

def carputils.forcepss.planio.splitting_section_to_dict_v1	(		splitting,
			verbose = False
	)

splitting_section_to_dict_v2()

def carputils.forcepss.planio.splitting_section_to_dict_v2	(		splitting,
			verbose = False
	)

Variable Documentation

ACTIVE_FUNCTION_COND_NAMES

tuple carputils.forcepss.planio.ACTIVE_FUNCTION_COND_NAMES = ('gil', 'git', 'gin', 'gel', 'get', 'gen')

ACTIVE_FUNCTION_CV_NAMES

tuple carputils.forcepss.planio.ACTIVE_FUNCTION_CV_NAMES = ('vf', 'vs', 'vn')

DEFAULT_SOLVER

dictionary carputils.forcepss.planio.DEFAULT_SOLVER

Initial value:

=  {j2cKey.SOLVER_SRC_MODEL: 'monodomain',
                  j2cKey.SOLVER_BEQM: True,
                  j2cKey.SOLVER_MASSLUMPING: False,
                  j2cKey.SOLVER_OPSPLIT: True,
                  j2cKey.SOLVER_FIXGE: True,
                  j2cKey.SOLVER_DT: 25.0,
                  j2cKey.SOLVER_DX: 250.0,
                  j2cKey.SOLVER_TOLERANCE: 1.0e-6,
                  j2cKey.SOLVER_PARABSOLVE: 1,
                  j2cKey.SOLVER_SUBSTEP: 1}

DEFAULT_TUNING_DIR

string carputils.forcepss.planio.DEFAULT_TUNING_DIR = './init'

DEFAULT_VERSIONS

dictionary carputils.forcepss.planio.DEFAULT_VERSIONS

Initial value:

=  {j2cKey.SECTION_CONFIGURATIONS: 1,
                    j2cKey.SECTION_FUNCTIONS: 1,
                    j2cKey.SECTION_ELECTRODES: 1,
                    j2cKey.SECTION_SOLVER_SETUP: 1,
                    j2cKey.SECTION_SIMULATION_SETUPS: 1,
                    j2cKey.SECTION_SPLITTING: 1}