feelpp_toolbox_electric(1)

1. NAME

feelpp_toolbox_electric - electric toolbox application

2. SYNOPSIS

feelpp_toolbox_electric
  [--electric.filename  <path to .json specification file>]
  [--config-file <path to .cfg file]
  [--case <directory to model case>]
  [--case.dim 3]
  [--case.discretization P1]
  [--electric.ksp-monitor=<0,1>]
  [--electric.ksp-view=<0,1>]
  [--electric.ksp-type=<see below>]
  [--electric.pc-view=<0,1>]
  [--electric.pc-type=<see below>]
  [--electric.snes-monitor=<0,1>]
  [--electric.ksp-type=<see below>]

3. DESCRIPTION

feelpp_toolbox_electric is an application which can run electric model defined by a set of files : a geometry or mesh, a config file(.cfg) and a model file(.json)

The execution steps are as follows:

load the model
load the mesh
setup model (materials, initial and boundary condition)
execute the steady or unsteady simulation
post-process the results, viewable in paraview or ensight

3.1. Options

feelpp_toolbox_electric requires some options.

Table 1. Table of command-line feelpp_toolbox_electric options
Name	Description	Default value	Possible Values
case.dim	dimension of problem	3	2,3
case.discretization	discretization of problem	P1	P1,P2,P3
electric.filename	path to the .json specification case file	no default value	required from user
electric.ksp-monitor	monitor the Krylov Subspace iterations	0	0,1
electric.ksp-view	view the Krylov Subspace structure	0	0,1
electric.ksp-type	change the Krylov Subspace method	`gmres`	see PETSc documentation
electric.pc-view	view the Krylov Subspace structure	0	0,1
electric.pc-type	change the Krylov Subspace strategy	`lu`	see PETSc documentation
electric.snes-monitor	if applicable, monitor the non-linear solver iterations	0	0,1
electric.snes-type	if applicable, change the non-linear solver iterations	`newtonls`	see PETSc documentation

NOTE: 0 as option value means that the option is not enabled, 1 means it is enabled.

4. EXAMPLES

We are now using the feelpp/feelpp-toolboxes:latest docker images as described in docs.feelpp.org/user/0.110.0-rc.5/install/containers/#_docker to demonstrate feelpp_toolbox_electric usage.

Starting the docker feelpp/feelpp-toolboxes:latest

docker run --rm -ti -v $HOME/feel:/feel ghcr.io/feelpp/feelpp-toolboxes:v0.110.0-rc.5

Explanations about the command line

docker run (1)
--rm (2)
-ti (3)
-v $HOME/feel:/feel (4)
feelpp/feelpp-toolboxes (5)

1	run docker executable
2	remove container from docker once execution is done
3	run in interactive mode and enter the docker container
4	mount `$HOME/feel` on host to `/feel/` in docker: the results will be exported there
5	the docker container to execute, by default it uses the `latest` tag

Example of a command line to execute feelpp_toolbox_electric

mpirun --bind-to core -np 10 feelpp_toolbox_electric --case "github:{path:toolboxes/electric/cases/ElectroMagnets/HL-31_H1}"

Explanation of the command line to execute feelpp_toolbox_electric

mpirun --bind-to core (1)
  -np 10 (2)
  (3)
  --case "github:{path:toolboxes/electric/cases/ElectroMagnets/HL-31_H1}" (4)

1	execute in parallel using MPI with processes bound to cores
2	execute in parallel usisng 10 processes
3	the name of the toolbox application
4	case directory containing the model files (geometry, config and json). This case file is available remotely on github.

Other test cases can be found

locally in /usr/share/feelpp/data/testcases/toolboxes/electric.
on-line docs.feelpp.org/cases/latest/electric/README

5. RESOURCES

Feel++ Docs: docs.feelpp.org/toolboxes/latest/
Feel++ Cases for feelpp_toolbox_electric: docs.feelpp.org/cases/latest/electric/README
Feel++ Toolbox Docs for feelpp_toolbox_electric: docs.feelpp.org/toolboxes/latest/electric/

6. SEE ALSO

Feel++ Mesh Partitioner: Mesh partitioner for Feel++ Toolboxes docs.feelpp.org/user/latest/using/mesh_partitioner/
Feel++ Remote Tool: Access remote data(model cases, meshes) on Github and Girder in Feel++ applications. docs.feelpp.org/user/latest/using/remotedata/