FFconfigurator

Contents

FFconfigurator#

class zeroheliumkit.fem.freefemer.FFconfigurator(config_file: str, dielectric_constants: dict, ff_polynomial: int, extract_opt: list[ExtractConfig, dict] | dict | ExtractConfig, msh_refinements: int = None)[source]#

Bases: object

Dataclass to create the FreeFEM config yaml file.

Parameters:

  • config_file (str) – Path to the FreeFEM config yaml file.

  • dielectric_constants (dict) – Dictionary containing the dielectric constants for different physical volumes.

  • ff_polynomial (int) – Polynomial order for the FreeFEM script.

  • extract_opt (list[ExtractConfig] | dict) – List of ExtractConfig objects or a dictionary containing extraction options.

  • msh_refinements (int) – The number of iterations over which to refine the GMSH meshfile using TetGen. If no number is provided, will default to None and not iterate at all.

Methods

Attributes

msh_refinements

config_file

dielectric_constants

ff_polynomial

extract_opt

Contents