particleterm Derived Type

type, public, abstract, extends(pbeterm) :: particleterm

Abstract 1D PBE particle term class (aggregation and breakage).


Inherits

type~~particleterm~~InheritsGraph type~particleterm particleterm type~pbeterm pbeterm type~particleterm->type~pbeterm grid1 grid1 type~pbeterm->grid1 grid type~base base type~pbeterm->type~base

Inherited by

type~~particleterm~~InheritedByGraph type~particleterm particleterm type~aggterm aggterm type~aggterm->type~particleterm type~breakterm breakterm type~breakterm->type~particleterm type~pbe pbe type~pbe->type~aggterm agg type~pbe->type~breakterm break

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,

integer, public :: moment = 1

moment of conserved during aggregation/breakage
real(kind=rk), public, allocatable :: udot_birth(:)

rate of birth
real(kind=rk), public, allocatable :: udot_death(:)

rate of death

Type-Bound Procedures

procedure, public, pass(self) :: set_name

  • private pure subroutine set_name(self, name, default)

    Setter method for name.

    Arguments

    Type IntentOptional Attributes 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 IntentOptional 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 IntentOptional 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 IntentOptional 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 IntentOptional Attributes Name
    class(pbeterm), intent(inout) :: self

    object

procedure, public, pass(self) :: set_moment

  • private pure subroutine set_moment(self, moment)

    Setter method for moment.

    Arguments

    Type IntentOptional Attributes Name
    class(particleterm), intent(inout) :: self

    object
    integer, intent(in) :: moment

    moment of to be preserved upon aggregation/breakage

procedure, public, pass(self) :: particleterm_allocations

  • private pure subroutine particleterm_allocations(self)

    Allocator for arrays of particleterm class.

    Arguments

    Type IntentOptional Attributes Name
    class(particleterm), intent(inout) :: self

    object

Source Code

   type, extends(pbeterm), abstract :: particleterm
   !! Abstract 1D PBE particle term class (aggregation and breakage).
      integer :: moment = 1
         !! moment of \(x\) conserved during aggregation/breakage
      real(rk), allocatable :: udot_birth(:)
         !! rate of birth
      real(rk), allocatable :: udot_death(:)
         !! rate of death
   contains
      procedure, pass(self) :: set_moment
      procedure, pass(self) :: particleterm_allocations
   end type particleterm