(git:6a2e663)
dirichlet_bc_types Module Reference

Dirichlet boundary condition data types. More...

Functions/Subroutines

subroutine, public dbc_release (contacts, do_dbc_cube, pw_pool)
 releases the defined Dirichlet boundary region More...
 
subroutine, public dbc_tile_release (dbc, pw_pool)
 releases tiles More...
 
subroutine, public dbc_parameters_dealloc (dbc_params)
 deallocates dirichlet_bc_parameters type More...
 

Variables

integer, parameter, public aa_planar = 10
 
integer, parameter, public planar = 11
 
integer, parameter, public cylindrical = 20
 
integer, parameter, public aa_cuboidal = 30
 
integer, parameter, public circumscribed = 1
 
integer, parameter, public inscribed = 2
 
integer, parameter, public xy_plane = 110
 
integer, parameter, public xz_plane = 101
 
integer, parameter, public yz_plane = 011
 
integer, parameter, public x_axis = 100
 
integer, parameter, public y_axis = 010
 
integer, parameter, public z_axis = 001
 

Detailed Description

Dirichlet boundary condition data types.

History
08.2014 created [Hossein Bani-Hashemian] 10.2015 completely revised [Hossein Bani-Hashemian]
Author
Mohammad Hossein Bani-Hashemian

Function/Subroutine Documentation

◆ dbc_release()

subroutine, public dirichlet_bc_types::dbc_release ( type(dirichlet_bc_p_type), dimension(:), intent(inout), allocatable  contacts,
logical, intent(in)  do_dbc_cube,
type(pw_pool_type), intent(in), optional, pointer  pw_pool 
)

releases the defined Dirichlet boundary region

Parameters
contactsthe DBC region to be released
do_dbc_cube...
pw_poolpool of the plane wave grid
History
08.2014 created [Hossein Bani-Hashemian]
Author
Mohammad Hossein Bani-Hashemian

Definition at line 154 of file dirichlet_bc_types.F.

Here is the call graph for this function:
Here is the caller graph for this function:

◆ dbc_tile_release()

subroutine, public dirichlet_bc_types::dbc_tile_release ( type(dirichlet_bc_type), intent(inout), pointer  dbc,
type(pw_pool_type), intent(in), optional, pointer  pw_pool 
)

releases tiles

Parameters
dbc...
pw_poolpool of the plane wave grid
History
11.2015 created [Hossein Bani-Hashemian]
Author
Mohammad Hossein Bani-Hashemian

Definition at line 194 of file dirichlet_bc_types.F.

Here is the caller graph for this function:

◆ dbc_parameters_dealloc()

subroutine, public dirichlet_bc_types::dbc_parameters_dealloc ( type(dirichlet_bc_parameters), intent(inout)  dbc_params)

deallocates dirichlet_bc_parameters type

Parameters
dbc_paramsdbc parameters
History
08.2014 created [Hossein Bani-Hashemian]
Author
Mohammad Hossein Bani-Hashemian

Definition at line 233 of file dirichlet_bc_types.F.

Here is the caller graph for this function:

Variable Documentation

◆ aa_planar

integer, parameter, public dirichlet_bc_types::aa_planar = 10

Definition at line 128 of file dirichlet_bc_types.F.

◆ planar

integer, parameter, public dirichlet_bc_types::planar = 11

Definition at line 128 of file dirichlet_bc_types.F.

◆ cylindrical

integer, parameter, public dirichlet_bc_types::cylindrical = 20

Definition at line 128 of file dirichlet_bc_types.F.

◆ aa_cuboidal

integer, parameter, public dirichlet_bc_types::aa_cuboidal = 30

Definition at line 128 of file dirichlet_bc_types.F.

◆ circumscribed

integer, parameter, public dirichlet_bc_types::circumscribed = 1

Definition at line 133 of file dirichlet_bc_types.F.

◆ inscribed

integer, parameter, public dirichlet_bc_types::inscribed = 2

Definition at line 133 of file dirichlet_bc_types.F.

◆ xy_plane

integer, parameter, public dirichlet_bc_types::xy_plane = 110

Definition at line 136 of file dirichlet_bc_types.F.

◆ xz_plane

integer, parameter, public dirichlet_bc_types::xz_plane = 101

Definition at line 136 of file dirichlet_bc_types.F.

◆ yz_plane

integer, parameter, public dirichlet_bc_types::yz_plane = 011

Definition at line 136 of file dirichlet_bc_types.F.

◆ x_axis

integer, parameter, public dirichlet_bc_types::x_axis = 100

Definition at line 140 of file dirichlet_bc_types.F.

◆ y_axis

integer, parameter, public dirichlet_bc_types::y_axis = 010

Definition at line 140 of file dirichlet_bc_types.F.

◆ z_axis

integer, parameter, public dirichlet_bc_types::z_axis = 001

Definition at line 140 of file dirichlet_bc_types.F.