coconut_tools.pyTDM.init_TDm¶
Module for injecting a flux rope (TDm or RBSL) into a COCONUT simulation.
This script reads multiple configuration files (.ini) and executes a processing routine for each, injecting magnetic structures into the simulation environment. It is designed to operate within the pyTDm framework, especially focusing on COCONUT simulations, and manages the modification of CFmesh files if requested.
- Typical usage example:
execute_configs(path=’/path/to/configs/’, cfmesh=True)
This script expects config files with appropriate .ini format and uses the pyTDm library to parse and process them.
- coconut_tools.pyTDM.init_TDm.None¶
Functions
|
Reads and executes pyTDm configuration files for injecting magnetic structures into COCONUT simulations, with optional CFmesh modification. |
- coconut_tools.pyTDM.init_TDm.execute_configs(path=None, cfmesh=False)[source]¶
Reads and executes pyTDm configuration files for injecting magnetic structures into COCONUT simulations, with optional CFmesh modification.
- Parameters:
path (str) – Path where the configuration .ini files are located.
cfmesh (bool) – If True, a new corona.CFmesh will be created for COCONUT.
- Raises:
TypeError – If path is not specified.
- Return type:
- Returns:
None