adam_prism_ic_object

ADAM, PRISM Initial Conditions class definition, CPU backend.

Source: src/app/prism/common/adam_prism_ic_object.F90

Dependencies

Contents

• prism_ic_object
• initialize
• load_from_file
• set_initial_conditions
• description

Variables

Name	Type	Attributes	Description
INI_SECTION_NAME	character(len=18)	parameter	INI (config) file section name containing IC configs.
IC_TYPE_VACUUM	character(len=6)	parameter	Vacuum IC TYPE parameter.
IC_TYPE_RP	character(len=15)	parameter	Riemann Problem IC TYPE parameter.
IC_TYPE_PLANE_WAVE	character(len=10)	parameter	Riemann Problem IC TYPE parameter.
IC_TYPE_RMF	character(len=10)	parameter	Rotating Magnetic Field IC TYPE parameter.
IC_TYPE_MAGNETIC_NOZZLE	character(len=15)	parameter	Nozzle IC TYPE parameter.
IC_TYPE_RMF_NOZZLE	character(len=15)	parameter	Rotating Magnetic Field Nozzle IC TYPE parameter.
IC_TYPE_UNIFORM_FIELD	character(len=13)	parameter	Uniform field IC type parameter

Derived Types

prism_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.
q	real(kind=R8P)	allocatable	Primitive variables (Dx,Dy,Dz,Bx,By,Bz,Jx,Jy,Jz).
emin	real(kind=R8P)	allocatable	IC regions bounding box.
emax	real(kind=R8P)	allocatable	IC regions bounding box.
kx	real(kind=R8P)		Plane wave number in x direction.
ky	real(kind=R8P)		Plane wave number in y direction.
kz	real(kind=R8P)		Plane wave number in z direction.
lambda	real(kind=R8P)		Plane wave wavelength.
B0	real(kind=R8P)		Plane wave background magnetic field amplitude.
B_x	real(kind=R8P)		Unifom field value
B_y	real(kind=R8P)		Unifom field value
B_z	real(kind=R8P)		Unifom field value
D_x	real(kind=R8P)		Unifom field value
D_y	real(kind=R8P)		Unifom field value
D_z	real(kind=R8P)		Unifom field value
RMF_frequency	real(kind=R8P)		Rotating magnetic field frequency.
RMF_B_amplitude	real(kind=R8P)		Rotating magnetic field amplitude.
RMF_rotation_axis	character(len=99)		Rotating magnetic field rotation axis (X, Y, Z).
alpha	integer(kind=I4P)		RMF rotation axis coordinate 1
beta	integer(kind=I4P)		RMF rotation axis coordinate 2
gamma	integer(kind=I4P)		RMF rotation axis coordinate 3

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 on PRISM fields.

Subroutines

initialize

Initialize the equation.

subroutine initialize(self, file_parameters)

Arguments

Name	Type	Intent	Attributes	Description
self	class(prism_ic_object)	inout		IC.
file_parameters	type(file_ini)	in		Simulation parameters ini file handler.

Call graph

load_from_file

Load config from file.

subroutine load_from_file(self, file_parameters, go_on_fail)

Arguments

Name	Type	Intent	Attributes	Description
self	class(prism_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 on PRISM fields.

subroutine set_initial_conditions(self, physics, field, q)

Arguments

Name	Type	Intent	Attributes	Description
self	class(prism_ic_object)	in		IC.
physics	type(prism_physics_object)	in		Fluids physiscs.
field	type(field_object)	in		Field object.
q	real(kind=R8P)	inout		Field cell centered variables.

Call graph

Functions

description

Return a pretty-formatted object description.

Attributes: pure

Returns: character(len=:)

function description(self) result(desc)

Arguments

Name	Type	Intent	Attributes	Description
self	class(prism_ic_object)	in		IC.

Call graph