initialize-mu-sigma

Overview

The generate-models initialize-mu-sigma subcommand is part of the generate-models command group in isciml. This subcommand initializes the mu (magnetic permeability) and sigma (electrical conductivity) values for air and earth in a given mesh file.

Usage

singularity exec isciml.sif isciml generate-models initialize-mu-sigma [OPTIONS]

Description

This subcommand allows users to set initial values for magnetic permeability (mu) and electrical conductivity (sigma) in a mesh file. These parameters are crucial for accurate simulation of electromagnetic fields in non-invasive imaging applications.

Options

Option	Description	Default	Required
--mesh PATH	Path to the input mesh file.	-	Yes
--air_mu_value FLOAT	Mu value to assign to air.	1.0	No
--air_sigma_value FLOAT	Sigma value to assign to air.	1e-08	No
--earth_mu_value FLOAT	Mu value to assign to earth.	1.0	No
--earth_sigma_value FLOAT	Sigma value to assign to earth.	0.01	No
--mu_value_key TEXT	Key to use for the mu value in the mesh file.	"mu"	No
--sigma_value_key TEXT	Key to use for the sigma value in the mesh file.	"sigma"	No
--output_mesh PATH	Path and filename for the output mesh file.	-	Yes
--help	Show the help message and exit.	-	No

Example

To initialize mu and sigma values for a mesh file with custom values:

singularity exec isciml.sif isciml generate-models initialize-mu-sigma \
    --mesh /path/to/input/mesh.vtk \
    --air_mu_value 1.1 \
    --air_sigma_value 1e-09 \
    --earth_mu_value 1.2 \
    --earth_sigma_value 0.02 \
    --output_mesh /path/to/output/initialized_mesh.vtk

Output

The command will create a new mesh file at the specified output path with initialized mu and sigma values for air and earth regions.

Notes

• Ensure that the input mesh file contains distinct regions for air and earth.

• The default values provided are typical for air and earth in many geophysical applications, but may need adjustment based on specific scenarios.

• The mu_value_key and sigma_value_key options allow for flexibility in naming conventions within the mesh file.

• The --output_mesh option should specify both the path and the desired filename for the output mesh.

Related Commands

• generate-models inspect-mesh: Inspects the mesh and provides mesh information.

• generate-models one-pipe: Generates models with a single pipe configuration.

See Also

For more information on electromagnetic properties in geophysical modeling, refer to the isciml documentation on physical parameter initialization and model setup.