particles_point Module

Numerical methods for lagrangian point particles


Uses

  • module~~particles_point~~UsesGraph module~particles_point particles_point module~leapblock leapBlock module~particles_point->module~leapblock module~leapeulerian leapEulerian module~particles_point->module~leapeulerian module~leapio leapIO module~particles_point->module~leapio module~leapkinds leapKinds module~particles_point->module~leapkinds module~leaplagrangian leapLagrangian module~particles_point->module~leaplagrangian module~leapparallel leapParallel module~particles_point->module~leapparallel mpi_f08 mpi_f08 module~particles_point->mpi_f08 module~leapblock->module~leapkinds module~leapblock->module~leapparallel module~leapblock->mpi_f08 module~leapeulerian->module~leapblock module~leapeulerian->module~leapio module~leapeulerian->module~leapkinds module~leapeulerian->module~leapparallel module~leapeulerian->mpi_f08 module~leapio_mpi leapIO_mpi module~leapeulerian->module~leapio_mpi module~leapparser leapParser module~leapeulerian->module~leapparser module~leaputils leapUtils module~leapeulerian->module~leaputils module~leapio_h5hut leapIO_h5hut module~leapio->module~leapio_h5hut module~leapio_hdf5 leapIO_hdf5 module~leapio->module~leapio_hdf5 module~leapio->module~leapio_mpi module~leapio_silo leapIO_silo module~leapio->module~leapio_silo iso_fortran_env iso_fortran_env module~leapkinds->iso_fortran_env module~leaplagrangian->module~leapblock module~leaplagrangian->module~leapio module~leaplagrangian->module~leapkinds module~leaplagrangian->module~leapparallel module~leaplagrangian->mpi_f08 module~leaplagrangian->module~leapparser module~leaplagrangian->module~leaputils module~leapparallel->module~leapkinds module~leapparallel->mpi_f08 module~leapparallel->module~leapparser module~leapio_h5hut->module~leapkinds module~leapio_h5hut->module~leapparallel h5hut h5hut module~leapio_h5hut->h5hut module~leapio_hdf5->module~leapkinds module~leapio_hdf5->module~leapparallel module~leapio_hdf5->module~leaputils hdf5 hdf5 module~leapio_hdf5->hdf5 module~leapio_mpi->module~leapblock module~leapio_mpi->module~leapkinds module~leapio_mpi->module~leapparallel module~leapio_mpi->mpi_f08 module~leapio_silo->module~leapblock module~leapio_silo->module~leapkinds module~leapio_silo->module~leapparallel module~leapio_silo->mpi_f08 module~leapio_silo->module~leaputils module~leapparser->module~leapkinds module~leapcli leapCli module~leapparser->module~leapcli module~leaputils->module~leapkinds module~leaputils->mpi_f08 module~leapcli->module~leapkinds

Used by

  • module~~particles_point~~UsedByGraph module~particles_point particles_point module~grans grans module~grans->module~particles_point module~grans_cases grans_cases module~grans->module~grans_cases module~grans_cases->module~particles_point module~nga_smod nga_smod module~nga_smod->module~particles_point module~grans_advancesolution_smod grans_AdvanceSolution_smod module~grans_advancesolution_smod->module~grans module~grans_module_smod grans_module_smod module~grans_module_smod->module~grans module~grans_preparesolver_smod grans_PrepareSolver_smod module~grans_preparesolver_smod->module~grans module~grans_writeoutputdata_smod grans_WriteOutputData_smod module~grans_writeoutputdata_smod->module~grans module~grans_writerestartdata_smod grans_WriteRestartData_smod module~grans_writerestartdata_smod->module~grans module~headon_collision_smod headon_collision_smod module~headon_collision_smod->module~grans_cases module~homogeneous_cooling_smod homogeneous_cooling_smod module~homogeneous_cooling_smod->module~grans_cases module~rotating_drum_smod rotating_drum_smod module~rotating_drum_smod->module~grans_cases program~main main program~main->module~grans

Variables

Type Visibility Attributes Name Initial
real(kind=wp), private, parameter :: BH_A(BH_E) = [0.23477481312586_wp, 0.28549576238194_wp, 0.28479416718255_wp, 0.26149775537574_wp, 0.32056200511938_wp, 0.35354490689146_wp, 0.39635904496921_wp, 0.42253908596514_wp, 0.48317384225265_wp, 0.63661146557001_wp]

Non-dimensional weights in BH kernel
integer, private, parameter :: BH_E = 10

Number of exponential functions used to approximate tail of BH kernel
integer, private, parameter :: BH_N = 5

Number of entries to track in time history
real(kind=wp), private, parameter :: BH_T(BH_E) = [0.1_wp, 0.3_wp, 1.0_wp, 3.9_wp, 10.0_wp, 40.0_wp, 190.0_wp, 1000.0_wp, 6500.0_wp, 50000.0_wp]

Non-dimensional time in BH kernel
integer, private, parameter :: PP_TYPE_BASSET = 2

Type used when computing Basset History force
integer, private, parameter :: PP_TYPE_DEFAULT = 1

Default type

Interfaces

interface

  • private module subroutine particle_set_ReadNGA(this, iter, time)

    Arguments

    Type IntentOptional Attributes Name
    class(particle_set), intent(inout) :: this

    Lagrangian array to dump
    integer, intent(out) :: iter

    Iteration at write
    real(kind=wp), intent(out) :: time

    Time at write

Derived Types

type, public, extends(particle_obj) ::  particle_BH_obj

A particle type that supports the computation of Basset History force

Components

Type Visibility Attributes Name Initial
real(kind=WP), public :: Fb(3)

Basset force
real(kind=WP), public :: Fc(3)

Collision force applied on particle
real(kind=WP), public :: Fcold(3)

Old collision force
real(kind=WP), public :: Fh(3)

Hydrodynamic force applied on particle
real(kind=WP), public :: Fhold(3)

Old hydrodynamic force
real(kind=WP), public :: Fix(BH_E)

Exponential tails of Basset kernel (x-dir)
real(kind=WP), public :: Fiy(BH_E)

Exponential tails of Basset kernel (y-dir)
real(kind=WP), public :: Fiz(BH_E)

Exponential tails of Basset kernel (z-idr)
real(kind=WP), public :: Tc(3)

Collision torque applied on particle
real(kind=WP), public :: Tcold(3)

Old collision torque
real(kind=WP), public :: Th(3)

Hydrodynamic torque applied on particle
real(kind=WP), public :: Thold(3)

Old hydrodynamic torque
integer, public :: c(3)

nearest cell
real(kind=WP), public :: d

Diameter of the particle
real(kind=WP), public :: gx(BH_N+1)

Time series of slip velocity derivatives (x-dir)
real(kind=WP), public :: gy(BH_N+1)

Time series of slip velocity derivatives (y-dir)
real(kind=WP), public :: gz(BH_N+1)

Time series of slip velocity derivatives (z-idr)
integer(kind=leapI8), public :: id

Identifying number (inactive if <0)
real(kind=WP), public :: p(3)

position
real(kind=WP), public :: pold(3)

Old particle position
real(kind=WP), public :: rho

Particle density
integer, public :: s

A tag
real(kind=WP), public :: v(3)

Particle velocity
real(kind=WP), public :: vold(3)

Old particle velocity
real(kind=WP), public :: vs(3)

Slip velocity
real(kind=WP), public :: w(3)

Particle velocity
real(kind=WP), public :: wold(3)

Old particle angular velocity

Type-Bound Procedures

procedure, public :: Extrapolate => lagrangian_obj_Extrapolate
procedure, public :: Interpolate => lagrangian_obj_Interpolate
procedure, public :: Locate => lagrangian_obj_Locate
procedure, public :: assign => particle_BH_obj_assign
generic, public :: assignment(=) => assign

type, public, extends(lagrangian_obj) ::  particle_obj

An extended Lagrangian object that represents a Lagrangian solid particle or liquid droplet

Components

Type Visibility Attributes Name Initial
real(kind=WP), public :: Fc(3)

Collision force applied on particle
real(kind=WP), public :: Fcold(3)

Old collision force
real(kind=WP), public :: Fh(3)

Hydrodynamic force applied on particle
real(kind=WP), public :: Fhold(3)

Old hydrodynamic force
real(kind=WP), public :: Tc(3)

Collision torque applied on particle
real(kind=WP), public :: Tcold(3)

Old collision torque
real(kind=WP), public :: Th(3)

Hydrodynamic torque applied on particle
real(kind=WP), public :: Thold(3)

Old hydrodynamic torque
integer, public :: c(3)

nearest cell
real(kind=WP), public :: d

Diameter of the particle
integer(kind=leapI8), public :: id

Identifying number (inactive if <0)
real(kind=WP), public :: p(3)

position
real(kind=WP), public :: pold(3)

Old particle position
real(kind=WP), public :: rho

Particle density
integer, public :: s

A tag
real(kind=WP), public :: v(3)

Particle velocity
real(kind=WP), public :: vold(3)

Old particle velocity
real(kind=WP), public :: w(3)

Particle velocity
real(kind=WP), public :: wold(3)

Old particle angular velocity

Type-Bound Procedures

procedure, public :: Extrapolate => lagrangian_obj_Extrapolate
procedure, public :: Interpolate => lagrangian_obj_Interpolate
procedure, public :: Locate => lagrangian_obj_Locate
procedure, public :: assign => particle_obj_assign
generic, public :: assignment(=) => assign

type, public, extends(lagrangian_set) ::  particle_set

Array of particles

Components

Type Visibility Attributes Name Initial
integer, public :: MPI_SIZE = 44

MPI size
type(MPI_Datatype), public :: MPI_TYPE

MPI variable type
type(block_obj), public, pointer :: block => null()

Associated block structure
type(block_obj), public :: cblock

Collision block
integer, public :: count = 0

Total count across all MPI ranks
integer, public :: count_ = 0

Local count for this rank
integer, public, allocatable :: count_proc(:) Read more…
procedure(kernel_1D), public, nopass, pointer :: g1ex => int_g1_triangle

1D kernel used in extrapolations
procedure(kernel_1D), public, nopass, pointer :: g1in => g1_triangle

1D kernel used in interpolations
real(kind=wp), public :: l_filter

Half filter width
character(len=:), public, allocatable :: name

Name of the Lagrangian set
type(sllist_obj), public, allocatable :: neighbors(:,:,:)

Singly linked list of neighbors
integer, public, allocatable :: objincell(:,:,:)

Number of objects in this list
logical, public :: overwrite = .true.

Switch to overwrite IO files
class(lagrangian_obj), public, allocatable :: p(:)

Array of Lagrangian_obj or any extended type
type(parallel_obj), public, pointer :: parallel => null()

Associated parallel structure
integer, public :: part_type = PP_TYPE_DEFAULT

Particle type to use
character(len=str64), public :: read_file

file to read
class(lagrangian_obj), public, allocatable :: sample

Sample used in allocation of polymorphic data
integer, public :: stib = 3

Stencil size for filtering
character(len=str64), public :: write_file

file to write

Type-Bound Procedures

procedure, public :: ApplyPeriodicity => lagrangian_set_ApplyPeriodicity
procedure, public :: Communicate => lagrangian_set_Communicate
procedure, public :: CreateMPIType => lagrangian_set_CreateMPIType
procedure, public :: Filter => particle_set_Filter
generic, public :: Finalize => lagrangian_set_Final
procedure, public :: FreeNeighborList => lagrangian_set_FreeNeighborList
procedure, public :: GetOwnerRankByBlock => lagrangian_set_GetOwnerRankByBlock
procedure, public :: GetReadFileName => lagrangian_set_GetReadFileName
procedure, public :: GetWriteFileName => lagrangian_set_GetWriteFileName
procedure, public :: Info => lagrangian_set_Info
generic, public :: Initialize => lagrangian_set_Init, particle_set_Init
procedure, public :: Localize => lagrangian_set_Localize
procedure, public :: Read => particle_set_Read
procedure, public :: ReadNGA => particle_set_ReadNGA
procedure, public :: Recycle => lagrangian_set_Recycle
procedure, public :: Resize => lagrangian_set_Resize
procedure, public :: SetFilterKernel => lagrangian_set_SetFilterKernel
procedure, public :: SetFilterSize => lagrangian_set_SetFilterSize
procedure, public :: SetMPIDataTypeParams => particle_set_SetMPIDataTypeParams
procedure, public :: SetObjectType => particle_SetObjectType
procedure, public :: SetOverwrite => lagrangian_set_SetOverwrite
procedure, public :: SetReadFileName => lagrangian_set_SetReadFileName
procedure, public :: SetWriteFileName => lagrangian_set_SetWriteFileName
procedure, public :: SetupCollisionBlock => lagrangian_set_SetupCollisionBlock
procedure, public :: UpdateCount => lagrangian_set_UpdateCount
procedure, public :: UpdateGhostObjects => lagrangian_set_UpdateGhostObjects
procedure, public :: UpdateNeighborList => lagrangian_set_UpdateNeighborList
procedure, public :: Write => particle_set_Write
procedure, public :: lagrangian_set_Final
procedure, public :: lagrangian_set_Init
procedure, private :: particle_set_Init

Subroutines

private subroutine particle_BH_obj_assign(this, val)

Assignment

Arguments

Type IntentOptional Attributes Name
class(particle_BH_obj), intent(inout) :: this

An particle_obj object
class(lagrangian_obj), intent(in) :: val

An particle_obj object

private subroutine particle_SetObjectType(this)

Set the sample type used in allocation of polymorphic variables

Arguments

Type IntentOptional Attributes Name
class(particle_set), intent(inout) :: this

Lagrangian array to dump

private subroutine particle_obj_assign(this, val)

Assignment

Arguments

Type IntentOptional Attributes Name
class(particle_obj), intent(inout) :: this

An particle_obj object
class(lagrangian_obj), intent(in) :: val

An particle_obj object

private subroutine particle_set_Filter(this, var, field)

Filter a quantity to the Eulerian grid

Arguments

Type IntentOptional Attributes Name
class(particle_set), intent(inout) :: this

Set of Lagrangian objects
character(len=*), intent(in) :: var

Variable to compute
type(eulerian_obj_r), intent(inout) :: field

Filtered quantity

private subroutine particle_set_Init(this, name, block, parallel, type)

Alternate initialization to be used when particle type is present

Arguments

Type IntentOptional Attributes Name
class(particle_set), intent(inout) :: this

Set of particles
character(len=*), intent(in) :: name

Name of variable
type(block_obj), intent(in), target :: block

A block object
type(parallel_obj), intent(in), target :: parallel

parallel structure from main program
character(len=*), intent(in) :: type

particle type

private subroutine particle_set_Read(this, iter, time)

Read particle data from file in parallel

Arguments

Type IntentOptional Attributes Name
class(particle_set), intent(inout) :: this

Lagrangian array to dump
integer, intent(out) :: iter

Iteration at write
real(kind=wp), intent(out) :: time

Time at write

private subroutine particle_set_SetMPIDataTypeParams(this, types, lengths, displacement)

Set up parameters used when creating the MPI derived type

Arguments

Type IntentOptional Attributes Name
class(particle_set), intent(inout) :: this

Set of Lagrangian objects
type(MPI_Datatype), intent(out), allocatable :: types(:)

Array of types
integer, intent(out), allocatable :: lengths(:)

Array of lengths
integer(kind=MPI_ADDRESS_KIND), intent(out), allocatable :: displacement(:)

Array of displacements

private subroutine particle_set_SetMPIDataTypeParams_BH(this, types, lengths, displacement)

Set up parameters used when creating the MPI derived type

Arguments

Type IntentOptional Attributes Name
class(particle_set), intent(inout) :: this

Set of Lagrangian objects
type(MPI_Datatype), intent(out), allocatable :: types(:)

Array of types
integer, intent(out), allocatable :: lengths(:)

Array of lengths
integer(kind=MPI_ADDRESS_KIND), intent(out), allocatable :: displacement(:)

Array of displacements

private subroutine particle_set_SetMPIDataTypeParams_default(this, types, lengths, displacement)

Set up parameters used when creating the MPI derived type

Arguments

Type IntentOptional Attributes Name
class(particle_set), intent(inout) :: this

Set of Lagrangian objects
type(MPI_Datatype), intent(out), allocatable :: types(:)

Array of types
integer, intent(out), allocatable :: lengths(:)

Array of lengths
integer(kind=MPI_ADDRESS_KIND), intent(out), allocatable :: displacement(:)

Array of displacements

private subroutine particle_set_Write(this, iter, time)

Write particle data to file in parallel

Arguments

Type IntentOptional Attributes Name
class(particle_set), intent(inout) :: this

Lagrangian array to dump
integer, intent(in) :: iter

Iteration at write
real(kind=wp), intent(in) :: time

Time at write