windse.ParameterManager

The ParameterManager controls the handles importing the parameters from the params.yaml file. These functions don’t need to be accessed by the end user.

class windse.ParameterManager.Parameters

Bases: dict

Parameters is a subclass of pythons dict that adds function specific to windse.

Load(loc, updated_parameters=[])

This function loads the parameters from the .yaml file. It should only be assessed once from the windse.initialize() function.

Parameters:loc (str) – This string is the location of the .yaml parameters file.
Read()

This function reads the current state of the parameters object and prints it in a easy to read way.

Save(func, filename, subfolder='', val=0, file=None, filetype='default')

This function is used to save the various dolfin.Functions created by windse. It should only be accessed internally.

Parameters:
  • func (dolfin.Function) – The Function to be saved
  • filename (str) – the name of the function
Keyword Arguments:
 
  • subfolder (str): where to save the files within the output folder
  • n (float): used for saving a series of output. Use n=0 for the first save.
fprint(string, tab=None, offset=0, special=None)

This is just a fancy print function that will tab according to where we are in the solve

Parameters:

string (str) – the string for printing
Keyword Arguments:
 
  • tab (int): the tab level

Classes

class windse.ParameterManager.Logger(filename, std, rank)

Bases: object

class windse.ParameterManager.Parameters

Bases: dict

Parameters is a subclass of pythons dict that adds function specific to windse.

Load(loc, updated_parameters=[])

This function loads the parameters from the .yaml file. It should only be assessed once from the windse.initialize() function.

Parameters:loc (str) – This string is the location of the .yaml parameters file.
Read()

This function reads the current state of the parameters object and prints it in a easy to read way.

Save(func, filename, subfolder='', val=0, file=None, filetype='default')

This function is used to save the various dolfin.Functions created by windse. It should only be accessed internally.

Parameters:
  • func (dolfin.Function) – The Function to be saved
  • filename (str) – the name of the function
Keyword Arguments:
 
  • subfolder (str): where to save the files within the output folder
  • n (float): used for saving a series of output. Use n=0 for the first save.
fprint(string, tab=None, offset=0, special=None)

This is just a fancy print function that will tab according to where we are in the solve

Parameters:

string (str) – the string for printing
Keyword Arguments:
 
  • tab (int): the tab level