bmw_parallel_context::bmw_parallel_context_class Interface Reference

Base class representing a bmw parallel context. This contains all memory needed parameters needed to parallel processing. More...

Public Member Functions
procedure, pass	set_threads (this, num_threads)
	Set the number of threads.
procedure, pass	report (this, io_unit)
	Report the number of parallel processes and threads.
procedure, pass	reduce1 (this, buffer)
	Reduce parallel buffers.
procedure, pass	reduce2 (this, buffer)
	Reduce parallel buffers.
procedure, pass	reduce3 (this, buffer)
	Reduce parallel buffers.
procedure, pass	reduce4 (this, buffer)
	Reduce parallel buffers.
GENERIC	reduce reduce1, reduce2, reduce3, reduce4
procedure, pass	start (this, total)
	Compute the start index of a flat array.
procedure, pass	end (this, total)
	Compute the end index of a flat array.
FINAL	bmw_parallel_context_destruct (this)
	Deconstruct a bmw_parallel_context_class object.
class(bmw_parallel_context_class) function, pointer	bmw_parallel_context_construct (comm)
	Construct a bmw_context_class object.

Public Attributes
integer	offset
	Problem space offset.
integer	stride
	Problem space stride.
integer	num_threads
	Number of threads.
integer	comm = MPI_COMM_NULL
	MPI communicator reference for computation. BMW can be used as an embeded library. Multiple instances can be running in parallel on separate problems so do not assume the world comm.
logical	initialized_mpi
	Flag to mark if bmw intialized the MPI context.

Detailed Description

Base class representing a bmw parallel context. This contains all memory needed parameters needed to parallel processing.

Interface for the bmw_parallel_context constructor.

Member Function/Subroutine Documentation

bmw_parallel_context_construct()

class (bmw_parallel_context_class) function, pointer bmw_parallel_context::bmw_parallel_context_class::bmw_parallel_context_construct

(

integer, intent(in)

comm

)

Construct a bmw_context_class object.

Allocates memory and initializes a bmw_parallel_context_class object.

Parameters

[in]

comm

MPI communicator. Only used if MPI support has been compiled in.

Returns

A pointer to a constructed bmw_parallel_context_class object.

bmw_parallel_context_destruct()

FINAL bmw_parallel_context::bmw_parallel_context_class::bmw_parallel_context_destruct ( type (bmw_parallel_context_class), intent(inout)  this )

final

Deconstruct a bmw_parallel_context_class object.

Deallocates memory and uninitializes a bmw_parallel_context_class object.

Parameters

[in,out]	this	A bmw_parallel_context_class instance.
[in]	finalize	Flag to call MPI_FINALIZE. Only used if MPI support has been compiled in.

end()

procedure, pass bmw_parallel_context::bmw_parallel_context_class::end	(	class (bmw_parallel_context_class), intent(in)	this,
		integer, intent(in)	total
	)

Compute the end index of a flat array.

The total problem size is divided by the number of processes. Any remaining elements are added to the first few processes.

Parameters

[in]	this	A bmw_parallel_context_class instance.
[in]	total	Total number of elements in the loop.

Returns

The Ending index for parallel multiprocess computation.

reduce1()

procedure, pass bmw_parallel_context::bmw_parallel_context_class::reduce1	(	class (bmw_parallel_context_class), intent(in)	this,
		real (rprec), dimension(:), intent(inout)	buffer
	)

Reduce parallel buffers.

Reduce a buffer from all parallel processes. In the single processes case, this reduces to nothing. This reduces a 1D buffer.

Parameters

[in]	this	A bmw_parallel_context_class instance.
[in,out]	buffer	Buffer to reduce.

reduce2()

procedure, pass bmw_parallel_context::bmw_parallel_context_class::reduce2	(	class (bmw_parallel_context_class), intent(in)	this,
		real (rprec), dimension(:,:), intent(inout)	buffer
	)

Reduce parallel buffers.

Reduce a buffer from all parallel processes. In the single processes case, this reduces to nothing. This reduces a 2D buffer.

Parameters

[in]	this	A bmw_parallel_context_class instance.
[in,out]	buffer	Buffer to reduce.

reduce3()

procedure, pass bmw_parallel_context::bmw_parallel_context_class::reduce3	(	class (bmw_parallel_context_class), intent(in)	this,
		real (rprec), dimension(:,:,:), intent(inout)	buffer
	)

Reduce parallel buffers.

Reduce a buffer from all parallel processes. In the single processes case, this reduces to nothing. This reduces a 3D buffer.

Parameters

[in]	this	A bmw_parallel_context_class instance.
[in,out]	buffer	Buffer to reduce.

reduce4()

procedure, pass bmw_parallel_context::bmw_parallel_context_class::reduce4	(	class (bmw_parallel_context_class), intent(in)	this,
		real (rprec), dimension(:,:,:,:), intent(inout)	buffer
	)

Reduce parallel buffers.

Reduce a buffer from all parallel processes. In the single processes case, this reduces to nothing. This reduces a 4D buffer.

Parameters

[in]	this	A bmw_parallel_context_class instance.
[in,out]	buffer	Buffer to reduce.

report()

procedure, pass bmw_parallel_context::bmw_parallel_context_class::report	(	class (bmw_parallel_context_class), intent(inout)	this,
		integer, intent(in)	io_unit
	)

Report the number of parallel processes and threads.

Provides a summary report if the number of threads and processes currently configured.

Parameters

[in]	this	A bmw_parallel_context_class instance.
[in]	io_unit	Unit number to write messages to.

set_threads()

procedure, pass bmw_parallel_context::bmw_parallel_context_class::set_threads	(	class (bmw_parallel_context_class), intent(inout)	this,
		integer, intent(in)	num_threads
	)

Set the number of threads.

Sets the number of OpenMP threads to use.

Parameters

[in]	this	A bmw_parallel_context_class instance.
[in]	num_threads	Number of threads to use.

start()

procedure, pass bmw_parallel_context::bmw_parallel_context_class::start	(	class (bmw_parallel_context_class), intent(in)	this,
		integer, intent(in)	total
	)

Compute the start index of a flat array.

The total problem size is divided by the number of processes. Any remaining elements are added to the first few processes.

Parameters

[in]	this	A bmw_parallel_context_class instance.
[in]	total	Total number of elements in the loop.

Returns

The Starting index for parallel multiprocess computation.

---

The documentation for this interface was generated from the following file:

• BMW/Sources/bmw_parallel_context.f