FieldDynamics for Prescribed Fields Simulations¶
This page describes the Field options available for prescribed field simulations, that is,
when the field solver
in the Basic Settings
element is set to prescribed fields
.
Fields¶
- externalElectricField
The Electric Field as prescribed by the user.
- kind (un-editable)
External Electric Field
- description
A space to provide a descriptive comment for the field.
- field type
electric field(cannot be changed)
- field specification
Either import h5 file or function defined.
- function defined
Allows for manual specification of each component of the field
- component 0:
The function defining the field in the 0th component. Can be a time varying function
- component 1:
The function defining the field in the 1st component. Can be a time varying function
- component 2:
The function defining the field in the 2nd component. Can be a time varying function
import h5 file A vis schema compliant h5 file. It does require that the file be in the same directory as the simulation. An error message will be provided if the file fails to import.
- filename:
The name of the .hdf5 file to be imported. Typical convention is simulationName_fieldName_dumpNum.h5
- lower bound 0:
The cell index of the 0th component lower bound of the source field, to be imported to the matching index in the simulation. If left not applicable the entire field will be imported.
- lower bound 1:
The cell index of the 1st component lower bound of the source field, to be imported to the matching index in the simulation. If left not applicable the entire field will be imported.
- lower bound 2:
The cell index of the 2nd component lower bound of the source field, to be imported to the matching index in the simulation. If left not applicable the entire field will be imported.
- upper bound 0:
The cell index of the 0th component upper bound of the source field, to be imported to the matching index in the simulation. If left not applicable the entire field will be imported.
- upper bound 1:
The cell index of the 1st component upper bound of the source field, to be imported to the matching index in the simulation. If left not applicable the entire field will be imported.
- upper bound 2:
The cell index of the 2nd component upper bound of the source field, to be imported to the matching index in the simulation. If left not applicable the entire field will be imported.
- externalMagneticField
The Magnetic Field as prescribed by the user.
- kind (un-editable)
External Magnetic Field
- description
A space to provide a descriptive comment for the field.
- field type
magnetic (cannot be changed)
- field specification
Either import h5 file or function defined.
- function defined
Allows for manual specification of each component of the field
- component 0:
The function defining the field in the 0th component. Can be a time varying function
- component 1:
The function defining the field in the 1st component. Can be a time varying function
- component 2:
The function defining the field in the 2nd component. Can be a time varying function
import h5 file A vis schema compliant h5 file. It does require that the file be in the same directory as the simulation. An error message will be provided if the file fails to import.
- filename:
The name of the .hdf5 file to be imported. Typical convention is simulationName_fieldName_dumpNum.h5
- lower bound 0:
The cell index of the 0th component lower bound of the source field, to be imported to the matching index in the simulation. If left not applicable the entire field will be imported.
- lower bound 1:
The cell index of the 1st component lower bound of the source field, to be imported to the matching index in the simulation. If left not applicable the entire field will be imported.
- lower bound 2:
The cell index of the 2nd component lower bound of the source field, to be imported to the matching index in the simulation. If left not applicable the entire field will be imported.
- upper bound 0:
The cell index of the 0th component upper bound of the source field, to be imported to the matching index in the simulation. If left not applicable the entire field will be imported.
- upper bound 1:
The cell index of the 1st component upper bound of the source field, to be imported to the matching index in the simulation. If left not applicable the entire field will be imported.
- upper bound 2:
The cell index of the 2nd component upper bound of the source field, to be imported to the matching index in the simulation. If left not applicable the entire field will be imported.
Time Dependence Properties¶
Time Dependence is available for prescribed field simulations.
- E-Field multiplier
Time dependent function to be applied at each time step to the electric field.
- B-Field multiplier
Time dependent function to be applied at each time step to the magnetic field.