Previous  Up  

Module Nvector_mpiplusx.Any

module Any: sig .. end

A generic nvector interface to mpiplusx nvectors.

Create mpiplusx nvectors using the generic nvector interface where the payload is wrapped with the MpiPlusX constructor.

val wrap : ?context:Sundials.Context.t ->
       ?with_fused_ops:bool -> Mpi.communicator -> Nvector.any -> Nvector.any

Creates a generic nvector from an mpi communicator and a generic nvector.

An optional argument permits to enable all the fused and array operations for a given nvector (they are disabled by default).

val unwrap : Nvector.any -> Nvector_mpiplusx.data

Returns the payload of the generic vector if it was constructed with MpiPlusX, otherwise raises Nvector.BadGenericType.

val enable : ?with_fused_ops:bool ->
       ?with_linear_combination:bool ->
       ?with_scale_add_multi:bool ->
       ?with_dot_prod_multi:bool ->
       ?with_linear_sum_vector_array:bool ->
       ?with_scale_vector_array:bool ->
       ?with_const_vector_array:bool ->
       ?with_wrms_norm_vector_array:bool ->
       ?with_wrms_norm_mask_vector_array:bool -> Nvector.any -> unit

Selectively enable or disable fused and array operations. The with_fused_ops argument enables or disables all such operations.