ExtractConfig

Contents

ExtractConfig#

class zeroheliumkit.fem.freefemer.ExtractConfig(name: str, quantity: str, plane: str, coordinate1: tuple, coordinate2: tuple, coordinate3: int | float | list | dict, curvature_config: dict = None)[source]#

Bases: object

Dataclass for storing extraction configuration parameters.

Parameters:

  • name (str) – The name of the extract config; acts as a label for the data configuration.

  • quantity (str) – The quantity to be extracted (e.g., ‘phi’, ‘Ex’, ‘Ey’, ‘Ez’, ‘Cm’).

  • plane (str) – The plane for extraction (e.g., ‘xy’, ‘yz’, ‘xz’, ‘xyZ’).

  • coordinate1 (tuple) – A tuple containing the start and end coordinates and the number of points for the first coordinate.

  • coordinate2 (tuple) – A tuple containing the start and end coordinates and the number of points for the second coordinate.

  • coordinate3 (float | list | dict) – User can input a float, list, or dictionary depending on their desired configuration. All inputs are converted to a list.

Methods

Attributes

curvature_config

name

quantity

plane

coordinate1

coordinate2

coordinate3

Contents