pbepack_pbe – pbepack

Derived types and procedures to solve 1D PBEs.

Uses

- pbepack_kinds
- pbepack_growth
- pbepack_flow
- pbepack_break
- pbepack_agg
- pbepack_quadratures
- odepack_mod
- hrweno_grids
- pbepack_basetypes
- pbepack_lib
Help

Graph Key

Nodes of different colours represent the following:

Solid arrows point from a submodule to the (sub)module which it is descended from. Dashed arrows point from a module or program unit to modules which it uses.
Where possible, edges connecting nodes are given different colours to make them easier to distinguish in large graphs.

Used by

Help

Graph Key

Nodes of different colours represent the following:

Solid arrows point from a submodule to the (sub)module which it is descended from. Dashed arrows point from a module or program unit to modules which it uses.
Where possible, edges connecting nodes are given different colours to make them easier to distinguish in large graphs.

Interfaces

public interface pbe

private function pbe_init(grid, g, a, b, d, moment, update_a, update_b, update_d, name) result(self)

Initialize pbe object. $\frac{\partial}{\partial t} u(x,t) = \\ + \frac{\partial }{\partial x}\left ( g(x,\mathbf{y})u(x,t) \right ) \\ + \int _0^{x/2} a(x-x',x',\mathbf{y})u(x-x',t)u(x',t)dx' -u(x,t)\int _0^\infty a(x,x',\mathbf{y})u(x',t)dx' \\ + \int _x^\infty d(x,x',\mathbf{y})b(x',\mathbf{y})u(x',t)dx' -b(x,\mathbf{y})u(x,t)$

Arguments

Type	Intent	Optional	Attributes		Name
type(grid1),	intent(in),		target	::	grid	`grid1` object
procedure(gfnc_t),		optional		::	g	growth rate function, $g(x,\textbf{y})$
procedure(afnc_t),		optional		::	a	aggregation frequency function, $a(x,x',\textbf{y})$
procedure(bfnc_t),		optional		::	b	breakage frequency function, $b(x,\textbf{y})$
procedure(dfnc_t),		optional		::	d	daughter distribution function, $d(x,x',\textbf{y})$
integer,	intent(in),	optional		::	moment	moment of $x$ conserved during aggregation/breakage (default=1)
logical,	intent(in),	optional		::	update_a	if `true`, $a(x,x',\textbf{y})$ is reevaluated at each step (default=true)
logical,	intent(in),	optional		::	update_b	if `true`, $b(x,\textbf{y})$ is reevaluated at each step (default=true)
logical,	intent(in),	optional		::	update_d	if `true`, $d(x,x',\textbf{y})$ is reevaluated at each step (default=true)
character(len=*),	intent(in),	optional		::	name	name (default="pbe")

Return Value type(pbe)

public interface pbesol

private pure function pbesol_init(npoints, ncells, nenvs) result(res)

Initialize pbesol object.

Arguments

Type	Intent		Name
integer,	intent(in)	::	npoints	number of time points, i.e. `size(times)`
integer,	intent(in)	::	ncells	number of grid cells, i.e. `size(u)`
integer,	intent(in)	::	nenvs	number of environment variables, i.e. `size(y)`

Return Value type(pbesol)

Derived Types

type, public, extends(pbeterm) :: pbe

1D PBE class.

Components

Type	Visibility	Attributes		Name		Initial
character(len=:),	public,	allocatable	::	name			object name
character(len=:),	public,	allocatable	::	msg			error message
integer,	public		::	ierr	=	0	error code
logical,	public		::	inited	=	.false.	initialization flag
type(grid1),	public,	pointer	::	grid	=>	null()	pointer to grid object
real(kind=rk),	public,	allocatable	::	udot(:)			net rate of change, $d\bar{u_i}/dt$
type(aggterm),	public		::	agg			aggregation object
type(breakterm),	public		::	break			breakage object
type(growthterm),	public		::	growth			growth object
type(flowterm),	public		::	flow			flow object

Constructor

private function pbe_init (grid, g, a, b, d, moment, update_a, update_b, update_d, name)	Initialize `pbe` object. $\frac{\partial}{\partial t} u(x,t) = \\ + \frac{\partial }{\partial x}\left ( g(x,\mathbf{y})u(x,t) \right ) \\ + \int _0^{x/2} a(x-x',x',\mathbf{y})u(x-x',t)u(x',t)dx' -u(x,t)\int _0^\infty a(x,x',\mathbf{y})u(x',t)dx' \\ + \int _x^\infty d(x,x',\mathbf{y})b(x',\mathbf{y})u(x',t)dx' -b(x,\mathbf{y})u(x,t)$

Type-Bound Procedures

procedure , public , pass(self) :: set_name Subroutine
procedure , public , pass(self) :: error_msg Subroutine
procedure , public , pass(self) :: check_inited Subroutine
procedure , public , pass(self) :: set_grid Subroutine
procedure , public , pass(self) :: pbeterm_allocations Subroutine
procedure , public , pass(self) :: eval => pbe_eval Subroutine
procedure , public , pass(self) :: integrate => pbe_integrate Function

type, public, extends(base) :: pbesol

1D PBE solution class.

Components

Type	Visibility	Attributes		Name		Initial
character(len=:),	public,	allocatable	::	name			object name
character(len=:),	public,	allocatable	::	msg			error message
integer,	public		::	ierr	=	0	error code
logical,	public		::	inited	=	.false.	initialization flag
real(kind=rk),	public,	allocatable	::	t(:)			vector(npoints) of time points
real(kind=rk),	public,	allocatable	::	u(:,:)			array(ncells,npoints) of $\bar{u}_i(t_k)$
real(kind=rk),	public,	allocatable	::	y(:,:)			array(nenvs,npoints) of ${y}_j(t_k)$
integer,	public		::	nfev	=	0	number of evaluations of $d\bar{\textbf{u}}/dt$
logical,	public		::	success	=	.false.	flag indicating if integration was successfull

Constructor

private pure function pbesol_init (npoints, ncells, nenvs)	Initialize `pbesol` object.

Type-Bound Procedures

procedure , public , pass(self) :: set_name Subroutine
procedure , public , pass(self) :: error_msg Subroutine
procedure , public , pass(self) :: check_inited Subroutine
procedure , public , pass(self) :: write => pbesol_write Subroutine

pbepack_pbe Module

Contents

Interfaces

Derived Types

Uses

Used by

Contents

Interfaces

Derived Types

Interfaces

public interface pbe

private function pbe_init(grid, g, a, b, d, moment, update_a, update_b, update_d, name) result(self)

Arguments

Return Value type(pbe)

public interface pbesol

private pure function pbesol_init(npoints, ncells, nenvs) result(res)

Arguments

Return Value type(pbesol)

Derived Types

type, public, extends(pbeterm) :: pbe

Components

Constructor

Type-Bound Procedures

type, public, extends(base) :: pbesol

Components

Constructor

Type-Bound Procedures