pbe – pbepack

type, public, extends(pbeterm) :: pbe

1D PBE class.

Inherits

Help

Variables

name msg ierr inited grid udot agg break growth flow

Type-Bound Procedures

set_name error_msg check_inited set_grid pbeterm_allocations eval integrate

Source Code

pbe

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

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)

Type-Bound Procedures

procedure, public, pass(self) :: set_name

private pure subroutine set_name(self, name, default)

Setter method for name.

Arguments

Type	Intent	Optional		Name
class(base),	intent(inout)		::	self	object
character(len=*),	intent(in),	optional	::	name	name
character(len=*),	intent(in),	optional	::	default	default name

procedure, public, pass(self) :: error_msg

private pure subroutine error_msg(self, msg)

Error method.

Arguments

Type	Intent	Optional	Attributes		Name
class(base),	intent(inout)			::	self	object
character(len=*),	intent(in)			::	msg	message

procedure, public, pass(self) :: check_inited

private pure subroutine check_inited(self)

Check initialization method.

Arguments

Type	Intent	Optional	Attributes		Name
class(base),	intent(inout)			::	self	object

procedure, public, pass(self) :: set_grid

private subroutine set_grid(self, grid)

Setter method for grid.

Arguments

Type	Intent	Optional	Attributes		Name
class(pbeterm),	intent(inout)			::	self	object
type(grid1),	intent(in),		target	::	grid	`grid1` object

procedure, public, pass(self) :: pbeterm_allocations

private pure subroutine pbeterm_allocations(self)

Allocator for arrays of pbeterm class.

Arguments

Type	Intent	Optional	Attributes		Name
class(pbeterm),	intent(inout)			::	self	object

procedure, public, pass(self) :: eval => pbe_eval

private pure subroutine pbe_eval(self, u, y, uin, qin, qout, v, vdot, udot)

Evaluate total rate of change at a given instant.

Arguments

Type	Intent	Optional		Name
class(pbe),	intent(inout)		::	self	object
real(kind=rk),	intent(in)		::	u(:)	cell-average number density, $\bar{u_i}(t)$
real(kind=rk),	intent(in)		::	y(:)	environment vector, $y_j(t)$
real(kind=rk),	intent(in),	optional	::	uin(:)	inlet cell-average number density, $\bar{u_{\mathrm{in},i}}(t)$
real(kind=rk),	intent(in),	optional	::	qin	inlet flowrate, $q_{\mathrm{in}}(t)$
real(kind=rk),	intent(in),	optional	::	qout	outlet flowrate, $q_{\mathrm{out}}(t)$
real(kind=rk),	intent(in),	optional	::	v	system volume, $V(t)$
real(kind=rk),	intent(in),	optional	::	vdot	volume derivative, $\dot{V}(t)$
real(kind=rk),	intent(out),	optional	::	udot(:)	total rate of change, $\dot{u_i}(t)$

procedure, public, pass(self) :: integrate => pbe_integrate

private function pbe_integrate(self, times, u0fnc, y0, ydotfnc, atol, rtol, verbose) result(res)

Integrate PBE using LSODA as ODE solver.

Arguments

Type	Intent	Optional		Name
class(pbe),	intent(inout)		::	self	object
real(kind=rk),	intent(in)		::	times(:)	time sequence for which output is wanted; the first value of `times` must be the initial time
procedure(u0fnc_t)			::	u0fnc	initial condition of number density, $u(x,t=0)$
real(kind=rk),	intent(in),	optional	::	y0(:)	initial condition of environment vector, $y_j(t=0)$
procedure(ydotfnc_t),		optional	::	ydotfnc	derivative of environment vector, $dy_j/dt$
real(kind=rk),	intent(in),	optional	::	atol	absolute tolerance (default=1e-15)
real(kind=rk),	intent(in),	optional	::	rtol	relative tolerance (default=1e-5)
logical,	intent(in),	optional	::	verbose	verbose flag (default=false)

Return Value type(pbesol)

Source Code

   type, extends(pbeterm) :: pbe
   !! 1D PBE class.
      type(aggterm) :: agg
         !! aggregation object
      type(breakterm) :: break
         !! breakage object
      type(growthterm) :: growth
         !! growth object
      type(flowterm) :: flow
         !! flow object
   contains
      procedure, pass(self), public :: eval => pbe_eval
      procedure, pass(self), public :: integrate => pbe_integrate
   end type pbe

pbe Derived Type

Contents

Variables

Constructor

Type-Bound Procedures

Source Code

type, public, extends(pbeterm) :: pbe

Inherits

Contents

Variables

Constructor

Type-Bound Procedures

Source Code

Components

Constructor

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)

Type-Bound Procedures

procedure, public, pass(self) :: set_name

private pure subroutine set_name(self, name, default)

Arguments

procedure, public, pass(self) :: error_msg

private pure subroutine error_msg(self, msg)

Arguments

procedure, public, pass(self) :: check_inited

private pure subroutine check_inited(self)

Arguments

procedure, public, pass(self) :: set_grid

private subroutine set_grid(self, grid)

Arguments

procedure, public, pass(self) :: pbeterm_allocations

private pure subroutine pbeterm_allocations(self)

Arguments

procedure, public, pass(self) :: eval => pbe_eval

private pure subroutine pbe_eval(self, u, y, uin, qin, qout, v, vdot, udot)

Arguments

procedure, public, pass(self) :: integrate => pbe_integrate

private function pbe_integrate(self, times, u0fnc, y0, ydotfnc, atol, rtol, verbose) result(res)

Arguments

Return Value type(pbesol)

Source Code