apis.md

APIs

CurrentModule = ClimaComms

ClimaComms

Loading

ClimaComms.@import_required_backends
ClimaComms.cuda_is_required
ClimaComms.mpi_is_required

Devices

ClimaComms.AbstractDevice
ClimaComms.AbstractCPUDevice
ClimaComms.CPUSingleThreaded
ClimaComms.CPUMultiThreaded
ClimaComms.CUDADevice
ClimaComms.device
ClimaComms.device_functional
ClimaComms.array_type
ClimaComms.free_memory
ClimaComms.total_memory
ClimaComms.allowscalar
ClimaComms.@time
ClimaComms.@elapsed
ClimaComms.@assert
ClimaComms.@sync
ClimaComms.@cuda_sync
Adapt.adapt_structure(::Type{<:AbstractArray}, ::ClimaComms.AbstractDevice)

Threading

ClimaComms.@threaded
ClimaComms.@shmem_threaded
ClimaComms.threaded
ClimaComms.threadable
ClimaComms.shareable
ClimaComms.set_metadata
ClimaComms.disable_auto_sync
ClimaComms.auto_sync!
ClimaComms.sync_shmem_threads!
ClimaComms.shmem_array
ClimaComms.@unique_shmem_thread
ClimaComms.unique_shmem_thread
ClimaComms.shmem_reduce!
ClimaComms.shmem_mapreduce!
ClimaComms.shmem_any!
ClimaComms.shmem_all!
ClimaComms.shmem_sum!
ClimaComms.shmem_prod!
ClimaComms.shmem_maximum!
ClimaComms.shmem_minimum!

Contexts

ClimaComms.AbstractCommsContext
ClimaComms.SingletonCommsContext
ClimaComms.MPICommsContext
ClimaComms.AbstractGraphContext
ClimaComms.context
ClimaComms.graph_context
Adapt.adapt_structure(::Type{<:AbstractArray}, ::ClimaComms.AbstractCommsContext)

Logging

ClimaComms.OnlyRootLogger
ClimaComms.MPILogger
ClimaComms.FileLogger

Context operations

ClimaComms.init
ClimaComms.mypid
ClimaComms.iamroot
ClimaComms.nprocs
ClimaComms.abort

Collective operations

ClimaComms.barrier
ClimaComms.reduce
ClimaComms.reduce!
ClimaComms.allreduce
ClimaComms.allreduce!
ClimaComms.bcast

Graph exchange

ClimaComms.start
ClimaComms.progress
ClimaComms.finish