carputils.bundle.parfileadjustment Namespace Reference

Functions to adjust an openCARP parameter file to be included in a bundle. More...

Classes
class	_OCParam
	An object of this class represents an OpenCARP parameter. More...

Functions
def	get_OCparams ()
	Gets the list of openCARP parameters. More...
def	standardize_param_str (s)
	Computes the standardized string representing a parameter. More...
def	find_param (s, params)
	Find the parameter corresponding to the string s in params, if it exists. More...
def	filter_params (params, param_types)
	Filters a list of parameters (instances of _OCParam), keeping only those having a type contained in param_types. More...

Variables
list	MESH_EXTENSIONS = ['.elem', '.pts', '.lon', '.belem', '.bpts', '.blon', '.surf']
	StringFileParam = namedtuple('StringFileParam', 'name type separator')
list	STRING_FILEPARAMS

Detailed Description

Functions to adjust an openCARP parameter file to be included in a bundle.

Function Documentation

filter_params()

def carputils.bundle.parfileadjustment.filter_params	(		params,
			param_types
	)

Filters a list of parameters (instances of _OCParam), keeping only those having a type contained in param_types.

Parameters

params	list of _OCParam A list of openCARP parameters
param_types	list of str List of parameter types

Returns

List of filtered _OCParam parameters

find_param()

def carputils.bundle.parfileadjustment.find_param	(		s,
			params
	)

Find the parameter corresponding to the string s in params, if it exists.

Parameters

s	str string representing a parameter

Returns

an instance of _OCParam corresponding to the parameter given in s, None if it doesn't exist.

get_OCparams()

def carputils.bundle.parfileadjustment.get_OCparams

(

)

Gets the list of openCARP parameters.

Returns

The list of OpenCARP parameters

standardize_param_str()

def carputils.bundle.parfileadjustment.standardize_param_str

(

s

)

Computes the standardized string representing a parameter.

Returns

The string representing the parameter

Variable Documentation

MESH_EXTENSIONS

list carputils.bundle.parfileadjustment.MESH_EXTENSIONS = ['.elem', '.pts', '.lon', '.belem', '.bpts', '.blon', '.surf']

STRING_FILEPARAMS

list carputils.bundle.parfileadjustment.STRING_FILEPARAMS

Initial value:

=  [StringFileParam('plug_sv_dumps', 'WFile', ':'),
                     StringFileParam('im_sv_dumps', 'WFile', ','),
                     StringFileParam('rt_lib', 'RFile', ':'),
                     StringFileParam('orthoname', 'RFile', ':')]

StringFileParam

carputils.bundle.parfileadjustment.StringFileParam = namedtuple('StringFileParam', 'name type separator')