[This is preliminary documentation and is subject to change.]

The Environment type exposes the following members.

Constructors

  NameDescription
EnvironmentOverloaded.

Methods

  NameDescription
Abort
Terminates all processes.
Dispose
Finalizes the MPI environment. Users must call this routine to shut down MPI.
Equals
Determines whether the specified Object is equal to the current Object.
(Inherited from Object.)
Finalize
Verifies that the MPI environment has been finalized by calling Dispose().
(Overrides Object..::.Finalize()()().)
GetHashCode
Serves as a hash function for a particular type. GetHashCode()()() is suitable for use in hashing algorithms and data structures like a hash table.
(Inherited from Object.)
GetType
Gets the Type of the current instance.
(Inherited from Object.)
MemberwiseClone
Creates a shallow copy of the current Object.
(Inherited from Object.)
ToString
Returns a String that represents the current Object.
(Inherited from Object.)
TranslateErrorIntoException
Translates an MPI error code into an appropriate exception, then throws that exception.

Properties

  NameDescription
Finalized
Determine whether the MPI environment has been finalized.
HostRank
Returns the rank of the "host" process, if any.
Initialized
Determine whether the MPI environment has been initialized.
IORank
Returns the rank of the process (or processes) that can perform I/O via the normal language facilities. If no such rank exists, the result will be null; if every process can perform I/O, this will return the value anySource.
IsMainThread
Determines whether the calling thread is the main MPI thread. Will return true for the thread that called the Environment constructor to initialize MPI. The main thread is particularly important when the threading mode is Funneled, because in that model only the main thread can invoke MPI routines.
IsTimeGlobal
Determines whether the Time value is synchronized across all MPI processes (i.e., if Time is a global value).
MaxTag
Returns the maximum allowed tag value for use with MPI's point-to-point operations.
ProcessorName
Returns the name of the currently executing processor. This name does not have any specific form, but typically identifies the computere on which the proces is executing.
Threading
The level of threading support provided by the MPI library. This value describes whether and how the MPI library can be used in multi-threaded programs. The threading level is requested when the MPI library is initialized in the Environment(array<String>[]()[]%, Threading) constructor.
Time
Returns the time, in seconds, since some arbitrary time in the past. This value is typically used for timing parallel applications.
TimeResolution
Returns the resolution of Time, in seconds.

See Also