Appearance
adam_patch_bc_object
ADAM, PATCH Boundary Conditions class definition, CPU backend.
Source: src/app/patch/common/adam_patch_bc_object.F90
Dependencies
Contents
Variables
| Name | Type | Attributes | Description |
|---|---|---|---|
INI_SECTION_NAMES | character(len=8) | parameter | INI (config) file section name containing BC configs. |
BC_DIRICHLET | integer(kind=I4P) | parameter | Dirichlet, phi = c (0). |
BC_DIRICHLET_STR | character(len=9) | parameter | Dirichlet, string input. |
BC_TYPE_STR | character(len=9) | parameter | BC types list, string cast. |
Derived Types
patch_bc_object
Boundary Conditions class definition, CPU backend.
Components
| Name | Type | Attributes | Description |
|---|---|---|---|
mpih | type(mpih_object) | MPI handler. | |
bc_type | integer(kind=I4P) | Boundary condition type. | |
q | real(kind=R8P) | allocatable | Poisson field variable at BC. |
Type-Bound Procedures
| Name | Attributes | Description |
|---|---|---|
description | pass(self) | Return pretty-printed object description. |
initialize | pass(self) | Initialize BC. |
load_from_file | pass(self) | Load config from file. |
Subroutines
initialize
Initialize the equation.
fortran
subroutine initialize(self, file_parameters)Arguments
| Name | Type | Intent | Attributes | Description |
|---|---|---|---|---|
self | class(patch_bc_object) | inout | BC. | |
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_bc_object) | inout | BC. | |
file_parameters | type(file_ini) | in | Simulation parameters ini file handler. | |
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(patch_bc_object) | in | BC. |
Call graph