Appearance
adam_amr_object
ADAM, AMR markers class definition, CPU backend.
Source: src/lib/common/adam_amr_object.F90
Dependencies
Contents
Variables
| Name | Type | Attributes | Description |
|---|---|---|---|
INI_SECTION_NAME | character(len=3) | parameter | INI (config) file section name containing AMR markers configs. |
AMR_GEO | integer(kind=I4P) | parameter | Geometrical marker. |
AMR_GRAD | integer(kind=I4P) | parameter | Field gradient marker. |
AMR_TV | integer(kind=I4P) | parameter | Field total variation marker. |
AMR_LOHNER | integer(kind=I4P) | parameter | Loehner normalized second derivative marker (issue #74). |
AMR_GEO_SOLID | integer(kind=I4P) | parameter | AMR_GEO geometry kind: solid/IB index (legacy default). |
AMR_GEO_PRIMITIVE_BOX | integer(kind=I4P) | parameter | AMR_GEO geometry kind: primitive axis-aligned box. |
AMR_GEO_STL | integer(kind=I4P) | parameter | AMR_GEO geometry kind: STL surface file. |
AMR_DELTA_T_X | character(len=1) | parameter | Delta criterion type, dx. |
AMR_DELTA_T_Y | character(len=1) | parameter | Delta criterion type, dy. |
AMR_DELTA_T_Z | character(len=1) | parameter | Delta criterion type, dz. |
AMR_DELTA_T_MAX | character(len=3) | parameter | Delta criterion type, max(dx,dy,dz). |
Derived Types
amr_marker_object
AMR marker object.
Components
| Name | Type | Attributes | Description |
|---|---|---|---|
mode | integer(kind=I4P) | Marker mode. | |
delta_type | character(len=:) | allocatable | Type of delta criterion: 'x','y','z','max' (max=> max(x,y,z)). |
delta_fine | real(kind=R8P) | Fine cell space step. | |
delta_coarse | real(kind=R8P) | Coarse cell space step. | |
field | integer(kind=I4P) | Field array containing the marker variable, 1=q, 2=q_aux. | |
ivar | integer(kind=I4P) | Array index of variable used by refinement criterion. | |
tol | real(kind=R8P) | Tolerance. | |
solid | integer(kind=I4P) | Solid number (AMR_GEO + AMR_GEO_SOLID). | |
geo_type | integer(kind=I4P) | AMR_GEO geometry kind: solid|primitive|stl (default solid => legacy). | |
box_emin | real(kind=R8P) | Primitive box minimum corner (AMR_GEO + AMR_GEO_PRIMITIVE_BOX). | |
box_emax | real(kind=R8P) | Primitive box maximum corner (AMR_GEO + AMR_GEO_PRIMITIVE_BOX). | |
target_level | integer(kind=I4P) | Refine blocks below this level (AMR_GEO + AMR_GEO_PRIMITIVE_BOX). | |
stl_filename | character(len=:) | allocatable | STL surface file (AMR_GEO + AMR_GEO_STL). |
refine_tol | real(kind=R8P) | Refine above this estimator value (AMR_LOHNER). | |
derefine_tol | real(kind=R8P) | Derefine below this estimator value (AMR_LOHNER). | |
epsilon | real(kind=R8P) | Noise filter of the estimator (AMR_LOHNER). | |
floor | real(kind=R8P) | Absolute variation counted as noise (AMR_LOHNER). | |
buffer | integer(kind=I4P) | Ghost layers the estimator reads (AMR_LOHNER). |
amr_object
AMR markers class definition, CPU backend.
Components
| Name | Type | Attributes | Description |
|---|---|---|---|
iters | integer(kind=I4P) | AMR updates iterations number. | |
frequency | integer(kind=I4P) | AMR update time step frequency. | |
markers_number | integer(kind=I4P) | AMR number of markers. | |
regrid_prolongation | integer(kind=I4P) | Refined blocks filling. | |
regrid_prolongation_given | logical | regrid_prolongation set by the input. | |
markers | type(amr_marker_object) | allocatable | AMR array of marker objects. |
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. |
Subroutines
initialize
Initialize the equation.
fortran
subroutine initialize(self, file_parameters)Arguments
| Name | Type | Intent | Attributes | Description |
|---|---|---|---|---|
self | class(amr_object) | inout | AMR. | |
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(amr_object) | inout | AMR. | |
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(amr_object) | in | The tree. |
Call graph
prolongation_name
Return the input spelling of a prolongation kind.
Attributes: pure
Returns: character(len=:)
fortran
function prolongation_name(prolongation) result(name)Arguments
| Name | Type | Intent | Attributes | Description |
|---|---|---|---|---|
prolongation | integer(kind=I4P) | in | Prolongation kind, AMR_PROLONGATION_*. |
Call graph