Coder Templates package

The Coder Templates module provides templates that suport code generation in coder.py classes.

coder_templates.create_calib_c_template(language='C')

Retrieves template for a C function file that implements calibration mode calculation of model functions for a specific phase instance.

The calibration functions expose the model parameters using getters and setters, which otherwise are fixed as constants in the fast routines, allowing the compiler to optimize the resulting code.

The user does not normally call this function directly.

Parameters

languagestring

Language syntax for generated code, (“C” is the C99 programming language)

Returns

string :

The template string.

coder_templates.create_calib_h_template(language='C')

Retrieves template for an include file that implements calibration mode calculation of model functions for a specific phase instance.

The calibration functions expose the model parameters using getters and setters, which otherwise are fixed as constants in the fast routines, allowing the compiler to optimize the resulting code.

The user does not normally call this function directly.

Parameters

languagestring

Language syntax for generated code, (“C” is the C99 programming language)

Returns

string :

The template string.

coder_templates.create_calib_pyx_template(language='C')

Retrieves calib code template for cython pyx file.

Parameters

languagestring

Language syntax for generated code, (“C” is the C99 programming language)

Returns

string :

The template string.

coder_templates.create_code_for_born_functions(language='C')

Retrieves code that provides a reference to the Born functions.

Parameters

languagestring

Language syntax for generated code, (“C” is the C99 programming language)

Returns

string :

The template string.

coder_templates.create_code_for_debye_function(language='C')

Retrieves a block of code that provides an implementation of the Debye function.

Parameters

languagestring

Language syntax for generated code, (“C” is the C99 programming language)

Returns

string :

The template string.

coder_templates.create_code_for_dh_functions(language='C')

Retrieves code that provides a reference to the Debye-Hückel solvent functions.

Parameters

languagestring

Language syntax for generated code, (“C” is the C99 programming language)

Returns

string :

The template string.

coder_templates.create_fast_c_template(language='C')

Retrieves template for a C function file that implements fast calculation of model functions for a specific phase instance.

The user does not normally call this function directly.

Parameters

languagestring

Language syntax for generated code, (“C” is the C99 programming language)

Returns

string :

The template string.

coder_templates.create_fast_h_template(language='C')

Retrieves template for an include file that implements fast calculation of model functions for a specific phase instance.

The user does not normally call this function directly.

Parameters

languagestring

Language syntax for generated code, (“C” is the C99 programming language)

Returns

string :

The template string.

coder_templates.create_fast_pyx_template(language='C')

Retrieves fast code template for cython pyx file.

Parameters

languagestring

Language syntax for generated code, (“C” is the C99 programming language)

Returns

string :

The template string.

coder_templates.create_pyxbld_template(language='C')

Retrieves template for cython pyxbld file.

Parameters

languagestring

Language syntax for generated code, (“C” is the C99 programming language)

Returns

string :

The template string.

coder_templates.create_redundant_calib_TV_template(language='C')

Retrieves template for redundant thermodynamic functions associated with Helmholtz models.

Parameters

languagestring

Language syntax for generated code, (“C” is the C99 programming language)

Returns

string :

The template string.

coder_templates.create_redundant_function_template(language='C', model_type='TP')

Retrieves template for redundant thermodynamic functions.

Parameters

languagestring

Language syntax for generated code, (“C” is the C99 programming language)

model_type: string

Potential type, either Gibbs free energy (‘TP’) or Helmholtz free energy (‘TV’)

Returns

string :

The template string.

coder_templates.create_soln_calc_template(language='C')

Retrieves template for solution functions.

Parameters

languagestring

Language syntax for generated code, (“C” is the C99 programming language)

Returns

string :

The template string.

coder_templates.create_soln_calib_code_template(language='C')

Retrieves template for calibration code solution template.

Parameters

languagestring

Language syntax for generated code, (“C” is the C99 programming language)

Returns

string :

The template string.

coder_templates.create_soln_calib_extra_template(language='C')

Retrieves template for solution calibration functions that retrieve and set values of model parameters.

Parameters

languagestring

Language syntax for generated code, (“C” is the C99 programming language)

Returns

string :

The template string.

coder_templates.create_soln_calib_include_template(language='C')

Retrieves template for calibration include file solution template.

Parameters

languagestring

Language syntax for generated code, (“C” is the C99 programming language)

Returns

string :

The template string.

coder_templates.create_soln_calib_pyx_template(language='C')

Retrieves calib solution code template for cython pyx file.

Parameters

languagestring

Language syntax for generated code, (“C” is the C99 programming language)

Returns

string :

The template string.

coder_templates.create_soln_calib_template(language='C')

Retrieves template for solution calibration functions.

Parameters

languagestring

Language syntax for generated code, (“C” is the C99 programming language)

Returns

string :

The template string.

coder_templates.create_soln_deriv_template(language='C')

Retrieves template for solution derivative functions.

Parameters

languagestring

Language syntax for generated code, (“C” is the C99 programming language)

Returns

string :

The template string.

coder_templates.create_soln_fast_code_template(language='C')

Retrieves template for fast code solution template.

Parameters

languagestring

Language syntax for generated code, (“C” is the C99 programming language)

Returns

string :

The template string.

coder_templates.create_soln_fast_include_template(language='C')

Retrieves template for fast include file solution template.

Parameters

languagestring

Language syntax for generated code, (“C” is the C99 programming language)

Returns

string :

The template string.

coder_templates.create_soln_fast_pyx_template(language='C')

Retrieves fast solution code template for cython pyx file.

Parameters

languagestring

Language syntax for generated code, (“C” is the C99 programming language)

Returns

string :

The template string.

coder_templates.create_soln_pyxbld_template(language='C')

Retrieves template for cython solution pyxbld file.

Parameters

languagestring

Language syntax for generated code, (“C” is the C99 programming language)

Returns

string :

The template string.

coder_templates.create_soln_redun_template(language='C')

Retrieves template for solution redundant functions.

Parameters

languagestring

Language syntax for generated code, (“C” is the C99 programming language)

Returns

string :

The template string.

coder_templates.create_soln_std_state_include_template(language='C')

Retrieves template for standard state properties include template.

Parameters

languagestring

Language syntax for generated code, (“C” is the C99 programming language)

Returns

string :

The template string.

coder_templates.create_ordering_gaussj_template(language='C')

Retrieves template for generation of guassj code.

Parameters

languagestring

Language syntax for generated code, (“C” is the C99 programming language)

Returns

string :

The template string.

coder_templates.create_ordering_code_template(language='C')

Retrieves template for generation of ordering code.

Parameters

languagestring

Language syntax for generated code, (“C” is the C99 programming language)

Returns

string :

The template string.

coder_templates.create_complx_soln_calc_template(language='C')

Retrieves template for generation of solution property code.

Parameters

languagestring

Language syntax for generated code, (“C” is the C99 programming language)

Returns

string :

The template string.

coder_templates.create_complx_soln_calib_template(language='C')

Retrieves template for generation of solution property code.

Parameters

languagestring

Language syntax for generated code, (“C” is the C99 programming language)

Returns

string :

The template string.

coder_templates.create_speciation_code_template(language='C')

Retrieves template for generation of speciation code.

Parameters

languagestring

Language syntax for generated code, (“C” is the C99 programming language)

Returns

string :

The template string.

coder_templates.create_speciation_ordering_code_template(language='C')

Retrieves template for generation of speciation ordering code.

Parameters

languagestring

Language syntax for generated code, (“C” is the C99 programming language)

Returns

string :

The template string.