Appearance
adam_prism_io_object
ADAM, Maxwell IO handler class definition, CPU backend.
Source: src/app/prism/common/adam_prism_io_object.F90
Dependencies
Contents
- prism_io_object
- initialize
- load_from_file
- save_energy_error
- save_energy_history
- save_charge_conservation_history
- save_divergence_history
- close_file_residuals
- open_file_residuals
- save_residuals
- description
Variables
| Name | Type | Attributes | Description |
|---|---|---|---|
INI_SECTION_NAME | character(len=2) | parameter | INI (config) file section name containing IO configs. |
Derived Types
prism_io_object
PRISM IO handler class definition, CPU backend.
Components
| Name | Type | Attributes | Description |
|---|---|---|---|
file_parameters | type(file_ini) | Prism input file handler. | |
it_save | integer(kind=I4P) | Main output iteration save frequency. | |
output_basename | character(len=:) | allocatable | Basename of output files. |
restart | logical | Enable restart from old output data. | |
restart_basename | character(len=:) | allocatable | Basename of restart files. |
restart_save | integer(kind=I4P) | Restart output iteration save frequency. | |
save_memory_status | logical | Enable save of memory status during allocations. | |
residuals_save | integer(kind=I4P) | Residuals (norm) output iteration save frequency. | |
residuals_unit | integer(kind=I4P) | Residuals file unit. | |
energy_error_save | integer(kind=I4P) | Energy error output iteration save frequency. | |
energy_error_unit | integer(kind=I4P) | Energy error hystory file unit. | |
energy_history_save | integer(kind=I4P) | Energy history output iteration save frequency. | |
energy_history_unit | integer(kind=I4P) | Energy history file unit. | |
divergence_history_save | integer(kind=I4P) | Divergence history output iteration save frequency. | |
divergence_history_unit | integer(kind=I4P) | Divergence history file unit. | |
charge_conservation_history_unit | integer(kind=I4P) | ||
save_residual_fields | logical | Flag to activate residual fields saving. | |
save_curl_fields | logical | Flag to activate curl fields saving. | |
save_divergence_fields | logical | Flag to activate divergence fields saving. | |
save_gradient_fields | logical | Flag to activate gradient fields saving. | |
save_laplacian_fields | logical | Flag to activate gradient fields saving. |
Type-Bound Procedures
| Name | Attributes | Description |
|---|---|---|
description | pass(self) | Return pretty-printed object description. |
initialize | pass(self) | Initialize time handler. |
load_from_file | pass(self) | Load config from file. |
save_energy_error | pass(self) | Save energy error history. |
save_energy_history | pass(self) | Save energy history. |
save_divergence_history | pass(self) | Save divergence history. |
save_charge_conservation_history | pass(self) | |
close_file_residuals | pass(self) | Close file for saving residuals history. |
open_file_residuals | pass(self) | Open file for saving residuals history. |
save_residuals | pass(self) | Save residuals history. |
Subroutines
initialize
Initialize IO handler.
fortran
subroutine initialize(self, filename)Arguments
| Name | Type | Intent | Attributes | Description |
|---|---|---|---|---|
self | class(prism_io_object) | inout | IO handler. | |
filename | character(len=*) | in | File name of parameters file. |
Call graph
load_from_file
Load config from file.
fortran
subroutine load_from_file(self, file_parameters, go_on_fail)Arguments
| Name | Type | Intent | Attributes | Description |
|---|---|---|---|---|
self | class(prism_io_object) | inout | IO handler. | |
file_parameters | type(file_ini) | in | Simulation parameters ini file handler. | |
go_on_fail | logical | in | optional | Go on if load fails. |
Call graph
save_energy_error
Save energy error history.
fortran
subroutine save_energy_error(self, it, time, blocks_number, energy_D, energy_B, rms_energy_error_D, rms_energy_error_B, is_to_open, is_to_close)Arguments
| Name | Type | Intent | Attributes | Description |
|---|---|---|---|---|
self | class(prism_io_object) | inout | IO handler. | |
it | integer(kind=I4P) | in | Current iteration. | |
time | real(kind=R8P) | in | Current time. | |
blocks_number | integer(kind=I4P) | in | Current number of blocks. | |
energy_D | real(kind=R8P) | in | Energy history of D. | |
energy_B | real(kind=R8P) | in | Energy history of B. | |
rms_energy_error_D | real(kind=R8P) | in | RMS of energy history of D. | |
rms_energy_error_B | real(kind=R8P) | in | RMS of energy history of B. | |
is_to_open | logical | in | optional | Flag to open file before first saving. |
is_to_close | logical | in | optional | Flag to close file after last saving. |
Call graph
save_energy_history
Save energy history.
fortran
subroutine save_energy_history(self, it, time, blocks_number, energy_D, energy_B, coil_power, Poynting_flux, is_to_open, is_to_close)Arguments
| Name | Type | Intent | Attributes | Description |
|---|---|---|---|---|
self | class(prism_io_object) | inout | IO handler. | |
it | integer(kind=I4P) | in | Current iteration. | |
time | real(kind=R8P) | in | Current time. | |
blocks_number | integer(kind=I4P) | in | Current number of blocks. | |
energy_D | real(kind=R8P) | in | Energy history of D. | |
energy_B | real(kind=R8P) | in | Energy history of B. | |
coil_power | real(kind=R8P) | in | Coil power history. | |
Poynting_flux | real(kind=R8P) | in | Poynting flux history. | |
is_to_open | logical | in | optional | Flag to open file before first saving. |
is_to_close | logical | in | optional | Flag to close file after last saving. |
Call graph
save_charge_conservation_history
Save PIC charge-conservation diagnostic history.
fortran
subroutine save_charge_conservation_history(self, time, Q_particles, Q_deposited, Q_deposition_error, R_cont_L1, R_cont_L2, R_cont_Linf, dQ_num_net, dQ_num_abs, Gauss_L1, Gauss_L2, Gauss_Linf, is_to_open, is_to_close, do_write)Arguments
| Name | Type | Intent | Attributes | Description |
|---|---|---|---|---|
self | class(prism_io_object) | inout | IO handler. | |
time | real(kind=R8P) | in | Physical time. | |
Q_particles | real(kind=R8P) | in | Total particle charge. | |
Q_deposited | real(kind=R8P) | in | Total grid-deposited charge. | |
Q_deposition_error | real(kind=R8P) | in | Deposited-particle charge mismatch. | |
R_cont_L1 | real(kind=R8P) | in | Continuity residual L1 mean. | |
R_cont_L2 | real(kind=R8P) | in | Continuity residual L2 RMS. | |
R_cont_Linf | real(kind=R8P) | in | Continuity residual Linf. | |
dQ_num_net | real(kind=R8P) | in | Net numerical charge equivalent. | |
dQ_num_abs | real(kind=R8P) | in | Absolute numerical charge equivalent. | |
Gauss_L1 | real(kind=R8P) | in | Gauss-law residual L1 mean. | |
Gauss_L2 | real(kind=R8P) | in | Gauss-law residual L2 RMS. | |
Gauss_Linf | real(kind=R8P) | in | Gauss-law residual Linf. | |
is_to_open | logical | in | optional | Flag to open file before first saving. |
is_to_close | logical | in | optional | Flag to close file after last saving. |
do_write | logical | in | optional | Flag to write a data row. |
Call graph
save_divergence_history
Save energy history.
fortran
subroutine save_divergence_history(self, it, time, blocks_number, div_D, div_B, div_J, div_D_name, div_J_name, current_solver_residual, is_to_open, is_to_close)Arguments
| Name | Type | Intent | Attributes | Description |
|---|---|---|---|---|
self | class(prism_io_object) | inout | IO handler. | |
it | integer(kind=I4P) | in | Current iteration. | |
time | real(kind=R8P) | in | Current time. | |
blocks_number | integer(kind=I4P) | in | Current number of blocks. | |
div_D | real(kind=R8P) | in | Energy history of B. | |
div_B | real(kind=R8P) | in | Coil power history. | |
div_J | real(kind=R8P) | in | Poynting flux history. | |
div_D_name | character(len=*) | in | optional | Header label for div(D) monitor. |
div_J_name | character(len=*) | in | optional | Header label for the third monitor. |
current_solver_residual | real(kind=R8P) | in | optional | Current linear-solve residual diagnostic. |
is_to_open | logical | in | optional | Flag to open file before first saving. |
is_to_close | logical | in | optional | Flag to close file after last saving. |
Call graph
close_file_residuals
Close file for saving residuals history.
fortran
subroutine close_file_residuals(self)Arguments
| Name | Type | Intent | Attributes | Description |
|---|---|---|---|---|
self | class(prism_io_object) | in | IO handler. |
Call graph
open_file_residuals
Open file for saving residuals history.
fortran
subroutine open_file_residuals(self, nv)Arguments
| Name | Type | Intent | Attributes | Description |
|---|---|---|---|---|
self | class(prism_io_object) | inout | IO handler. | |
nv | integer(kind=I4P) | in | Number of residuals variables. |
Call graph
save_residuals
Save residuals history.
fortran
subroutine save_residuals(self, it, time, blocks_number, residuals)Arguments
| Name | Type | Intent | Attributes | Description |
|---|---|---|---|---|
self | class(prism_io_object) | in | IO handler. | |
it | integer(kind=I4P) | in | Current iteration. | |
time | real(kind=R8P) | in | Current time. | |
blocks_number | integer(kind=I4P) | in | Current number of blocks. | |
residuals | real(kind=R8P) | in | Residuals (norm) [1:nv]. |
Call graph
Functions
description
Return a pretty-formatted object description.
Attributes: pure
Returns: character(len=:)
fortran
function description(self) result(desc)Arguments
| Name | Type | Intent | Attributes | Description |
|---|---|---|---|---|
self | class(prism_io_object) | in | IO handler. |
Call graph