apis.md

APIs

CurrentModule = ClimaComms

ClimaComms

Loading

ClimaComms.@import_required_backends
ClimaComms.cuda_is_required
ClimaComms.metal_is_required
ClimaComms.mpi_is_required

Devices

ClimaComms.AbstractDevice
ClimaComms.AbstractCPUDevice
ClimaComms.CPUSingleThreaded
ClimaComms.CPUMultiThreaded
ClimaComms.CUDADevice
ClimaComms.MetalDevice
ClimaComms.device
ClimaComms.device_functional
ClimaComms.array_type
ClimaComms.allowscalar
ClimaComms.@time
ClimaComms.@elapsed
ClimaComms.@assert
ClimaComms.@sync
ClimaComms.@cuda_sync
Adapt.adapt_structure(::Type{<:AbstractArray}, ::ClimaComms.AbstractDevice)
ClimaComms.@threaded
ClimaComms.@interdependent
ClimaComms.InterdependentIteratorData
ClimaComms.@sync_interdependent
ClimaComms.synchronize_gpu_threads
ClimaComms.static_shared_memory_array

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