snek5000.params

Runtime parameters

Scripting interface for Nek5000 parameter file.

Module Attributes

filename_map_user_params

JSON file name to which recorded user_params are saved

Functions

camelcase(value)	Convert strings to camelCase.
complete_params_from_par_file(params, path)	Populate the params.nek object by reading a .par file and filename_map_user_params.
load_params([path_dir])	Load a snek5000.params.Parameters instance from path_dir.

Classes

Parameters(*args, **kwargs)

Container for reading, modifying and writing par files.

snek5000.params.filename_map_user_params = 'map_user_params.json'

JSON file name to which recorded user_params are saved

snek5000.params.camelcase(value)

Convert strings to camelCase.

snek5000.params.load_params(path_dir='.')

Load a snek5000.params.Parameters instance from path_dir.

Parameters

path_dir (str or path-like) – Path to a simulation directory.

Returns

params

Return type

snek5000.params.Parameters

class snek5000.params.Parameters(*args, **kwargs)

Container for reading, modifying and writing par files.

Parameters

tag – A string representing name of case files (for example: provide "abl" for files like abl.usr, abl.par etc).

snek5000.params.complete_params_from_par_file(params, path)

Populate the params.nek object by reading a .par file and filename_map_user_params.