Appearance
adam_patch_ic_object
ADAM, PATCH Initial Conditions class definition, common CPU backend.
Source: src/app/patch/common/adam_patch_ic_object.F90
Dependencies
Contents
Variables
| Name | Type | Attributes | Description |
|---|---|---|---|
INI_SECTION_NAME | character(len=18) | parameter | INI (config) file section name containing IC configs. |
IC_TYPE_GAUSS | character(len=5) | parameter | Gaussian distribution of rho IC TYPE parameter. |
Derived Types
patch_ic_object
Initial Conditions class definition, CPU backend.
Components
| Name | Type | Attributes | Description |
|---|---|---|---|
mpih | type(mpih_object) | MPI handler. | |
amr_iterations | integer(kind=I4P) | Number of AMR iterations imposing IC. | |
ic_type | character(len=:) | allocatable | IC type. |
regions_number | integer(kind=I4P) | Number of IC regions. | |
r | real(kind=R8P) | allocatable | Rho value. |
emin | real(kind=R8P) | allocatable | IC regions bounding box. |
emax | real(kind=R8P) | allocatable | IC regions bounding box. |
Type-Bound Procedures
| Name | Attributes | Description |
|---|---|---|
description | pass(self) | Return pretty-printed object description. |
initialize | pass(self) | Initialize IC. |
load_from_file | pass(self) | Load config from file. |
set_initial_conditions | pass(self) | Set initial conditions. |
Subroutines
initialize
Initialize the equation.
fortran
subroutine initialize(self, file_parameters)Arguments
| Name | Type | Intent | Attributes | Description |
|---|---|---|---|---|
self | class(patch_ic_object) | inout | IC. | |
file_parameters | type(file_ini) | in | Simulation parameters ini file handler. |
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(patch_ic_object) | inout | IC. | |
file_parameters | type(file_ini) | in | Simulation parameters ini file handler. | |
go_on_fail | logical | in | optional | Go on if load fails. |
Call graph
set_initial_conditions
Set initial conditions.
fortran
subroutine set_initial_conditions(self, field, r)Arguments
| Name | Type | Intent | Attributes | Description |
|---|---|---|---|---|
self | class(patch_ic_object) | in | IC. | |
field | type(field_object) | in | Field object. | |
r | real(kind=R8P) | inout | Conservative variables. |
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(patch_ic_object) | in | IC. |
Call graph