Appearance
adam_prism_coil_object
ADAM, PRISM coil source definition, CPU backend.
Source: src/app/prism/common/adam_prism_coil_object.F90
Dependencies
Contents
Variables
| Name | Type | Attributes | Description |
|---|---|---|---|
INI_SECTION_NAME | character(len=11) | parameter | INI (config) file section name containing coils configs. |
COIL_TYPE_RECTANGULAR | character(len=11) | parameter | Rectangular shape coil. |
COIL_TYPE_CIRCULAR | character(len=8) | parameter | Circular shape coil. |
CURRENT_TYPE_DC | character(len=10) | parameter | DC current. |
CURRENT_TYPE_AC | character(len=10) | parameter | AC current |
NORMAL_P_X | character(len=2) | parameter | Normal versor along positive x axis. |
NORMAL_M_X | character(len=2) | parameter | Normal versor along negative x axis. |
NORMAL_P_Y | character(len=2) | parameter | Normal versor along positive y axis. |
NORMAL_M_Y | character(len=2) | parameter | Normal versor along negative y axis. |
NORMAL_P_Z | character(len=2) | parameter | Normal versor along positive z axis. |
NORMAL_M_Z | character(len=2) | parameter | Normal versor along negative z axis. |
Derived Types
prism_coil_object
ADAM, PRISM coil source definition, CPU backend.
Components
| Name | Type | Attributes | Description |
|---|---|---|---|
mpih | type(mpih_object) | MPI handler. | |
coil_type | character(len=99) | allocatable | Coil type. |
current_type | character(len=99) | allocatable | Current type. |
normal | character(len=2) | allocatable | Versore normale alla spira, che identifica anche verso |
A | real(kind=R8P) | allocatable | Current amplitude (A) |
f | real(kind=R8P) | allocatable | Current frequency, if AC (Hz) |
phase | real(kind=R8P) | allocatable | Current initial phase, if AC |
x_center | real(kind=R8P) | allocatable | Coil center |
y_center | real(kind=R8P) | allocatable | Coil center |
z_center | real(kind=R8P) | allocatable | Coil center |
lx | real(kind=R8P) | allocatable | Rectangle's sizes (if rectangular coil) |
ly | real(kind=R8P) | allocatable | Rectangle's sizes (if rectangular coil) |
r_coil | real(kind=R8P) | allocatable | Circle's radius (if circular coil) |
sigma | real(kind=R8P) | allocatable | Gaussian current distribution sigma |
J_vec | real(kind=R8P) | allocatable | Matrice contenente versori corrente spire (se assente |
td | real(kind=R8P) | Delay di accensione della spira | |
coil_flag | integer(kind=I4P) | allocatable | Matrice contenente informazioni su quale spira pass pe |
circular_coils_number | integer(kind=I4P) | Number of circular coils | |
rectangular_coils_number | integer(kind=I4P) | Number of rectangular coils | |
total_coils_number | integer(kind=I4P) | Number of coils | |
ngc | integer(kind=I4P) | pointer | Number of ghost cells. |
ni | integer(kind=I4P) | pointer | Number of cells in i direction. |
nj | integer(kind=I4P) | pointer | Number of cells in j direction. |
nk | integer(kind=I4P) | pointer | Number of cells in k direction. |
nb | integer(kind=I4P) | pointer | Total blocks number for MPI. |
blocks_number | integer(kind=I4P) | pointer | Actual blocks number. |
Type-Bound Procedures
| Name | Attributes | Description |
|---|---|---|
allocate_coil | pass(self) | Allocate coil data. |
description | pass(self) | Return pretty-printed object description. |
initialize | pass(self) | Initialize IC. |
load_from_file | pass(self) | Load config from file. |
Subroutines
allocate_coil
Allocate coil data.
fortran
subroutine allocate_coil(self)Arguments
| Name | Type | Intent | Attributes | Description |
|---|---|---|---|---|
self | class(prism_coil_object) | inout | Coils. |
Call graph
initialize
Initialize the equation.
fortran
subroutine initialize(self, file_parameters, field)Arguments
| Name | Type | Intent | Attributes | Description |
|---|---|---|---|---|
self | class(prism_coil_object) | inout | Coils. | |
file_parameters | type(file_ini) | in | Simulation parameters ini file handler. | |
field | type(field_object) | in | The field. |
Call graph
load_from_file
Load config from file.
fortran
subroutine load_from_file(self, file_parameters, field, go_on_fail)Arguments
| Name | Type | Intent | Attributes | Description |
|---|---|---|---|---|
self | class(prism_coil_object) | inout | coils. | |
file_parameters | type(file_ini) | in | Simulation parameters ini file handler. | |
field | type(field_object) | in | target | The field. |
go_on_fail | logical | in | optional | Go on if load fails. |
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_coil_object) | in | IC. |
Call graph