pm_timer::timerMPI_type Interface Reference

This is the timerMPI_type class, containing attributes and static methods for setting up a timer based on the MPI intrinsic MPI_Wtime(). More...

Inheritance diagram for pm_timer::timerMPI_type:

Collaboration diagram for pm_timer::timerMPI_type:

Public Member Functions
procedure, nopass	time => getTimeMPI
	See getTime_proc. More...
procedure, nopass	wait => setIdleMPI
	See setIdle_proc. More...
type(timerMPI_type) function	timerMPI_typer ()
	This is the constructor of the timerMPI_type class. More...
Public Member Functions inherited from pm_timer::timer_type
procedure(getTime_proc), deferred, nopass	time
	See getTime_proc. More...
procedure(setIdle_proc), deferred, nopass	wait
	See setIdle_proc. More...
type(timerMPI_type) type(timerOMP_type) type(timerSYS_type) function	timer_typer ()
	This is the constructor of the timer_type class. More...

Additional Inherited Members
Public Attributes inherited from pm_timer::timer_type
real(RKD)	start
	The protected scalar real of kind double precision RKD provided as a convenience for the user to contain the start time of the timer since the processor epoch (a processor-dependent past time) in seconds. More...
real(RKD)	clock
	The scalar real of kind double precision RKD provided as a convenience for the user to contain the total time in seconds elapsed since the start of the timer. The clock time can be readily can be computed as timer%clock = timer%time(since = timer%start). More...
real(RKD)	delta
	The scalar real of kind double precision RKD provided as a convenience for the user to contain the delta time in seconds since the last timing (last timer call). The delta time can be readily can be computed as timer%delta = timer%time(since = timer%start) - timer%clock where timer%clock is the last clock read as timer%clock = timer%time(since = timer%start). More...
real(RKD)	resol
	The protected scalar real of kind double precision RKD provided as a convenience for the user to contain the time in seconds between the timer clock tics. More...

Detailed Description

This is the timerMPI_type class, containing attributes and static methods for setting up a timer based on the MPI intrinsic MPI_Wtime().

See the documentation of timerMPI_typer for the non-default constructor interface of this type.
See also the documentation details of pm_timer.

Possible calling interfaces ⛓

use pm_timer, only: timerMPI_type
type(timerMPI_type) :: timer
 
timer = timerMPI_type()

Note

This type is available only if the library is built with the preprocessor macro MPI_ENABLED=1.

See also

timer_type
timerDAT_type
timerMPI_type
timerOMP_type
timerSYS_type

Example usage ⛓

program example
 
    use pm_kind, only: IK, LK, SK, RKD
    use pm_io, only: display_type
 
    implicit none
 
    type(display_type) :: disp
    disp = display_type(file = "main.out.F90")
 
#if !defined MPI_VERSION
    call disp%show("The MPI timer is unavailable, because this example has not been linked with an MPI library.")
#else
    block
        use pm_timer, only: timerMPI_type
        type(timerMPI_type) :: timer
        logical(LK)         :: failed
        integer             :: i
        call disp%skip()
        call disp%show("timer = timerMPI_type()")
                        timer = timerMPI_type()
        call showTimerComponents()
        call disp%skip()
 
        call disp%skip()
        call disp%show("timer%clock = timer%time()")
                        timer%clock = timer%time()
        call showTimerComponents()
        call disp%skip()
 
        call disp%skip()
        call disp%show("timer%delta = timer%time(since = timer%start)")
                        timer%delta = timer%time(since = timer%start)
        call showTimerComponents()
        call disp%skip()
 
        call disp%skip()
        call disp%show("!%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%")
        call disp%show("!Idle for a certain number of seconds.")
        call disp%show("!%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%")
        call disp%skip()
 
        call disp%skip()
        call disp%show("timer = timerMPI_type()")
                        timer = timerMPI_type()
        call disp%show("call timer%wait(seconds = 0.1_RKD)")
                        call timer%wait(seconds = 0.1_RKD)
        call disp%show("timer%delta = timer%time() - timer%start")
                        timer%delta = timer%time() - timer%start
        call showTimerComponents()
        call disp%skip()
    end block
contains
    impure subroutine showTimerComponents()
        call disp%show("timer%start")
        call disp%show( timer%start )
        call disp%show("timer%clock")
        call disp%show( timer%clock )
        call disp%show("timer%delta")
        call disp%show( timer%delta )
        call disp%show("timer%resol")
        call disp%show( timer%resol )
    end subroutine
#endif
 
end program example

Example Unix compile command via Intel ifort compiler ⛓

#!/usr/bin/env sh
rm main.exe
ifort -fpp -standard-semantics -O3 -Wl,-rpath,../../../lib -I../../../inc main.F90 ../../../lib/libparamonte* -o main.exe
./main.exe

Example Windows Batch compile command via Intel ifort compiler ⛓

del main.exe
set PATH=..\..\..\lib;%PATH%
ifort /fpp /standard-semantics /O3 /I:..\..\..\include main.F90 ..\..\..\lib\libparamonte*.lib /exe:main.exe
main.exe

Example Unix / MinGW compile command via GNU gfortran compiler ⛓

#!/usr/bin/env sh
rm main.exe
gfortran -cpp -ffree-line-length-none -O3 -Wl,-rpath,../../../lib -I../../../inc main.F90 ../../../lib/libparamonte* -o main.exe
./main.exe

Example output ⛓

The MPI timer is unavailable, because this example has not been linked with an MPI library.
 

Test:

test_pm_timer

Final Remarks ⛓

---

If you believe this algorithm or its documentation can be improved, we appreciate your contribution and help to edit this page's documentation and source file on GitHub.
For details on the naming abbreviations, see this page.
For details on the naming conventions, see this page.
This software is distributed under the MIT license with additional terms outlined below.

1. If you use any parts or concepts from this library to any extent, please acknowledge the usage by citing the relevant publications of the ParaMonte library.
   
2. If you regenerate any parts/ideas from this library in a programming environment other than those currently supported by this ParaMonte library (i.e., other than C, C++, Fortran, MATLAB, Python, R), please also ask the end users to cite this original ParaMonte library.
   

This software is available to the public under a highly permissive license.
Help us justify its continued development and maintenance by acknowledging its benefit to society, distributing it, and contributing to it.

Copyright

Computational Data Science Lab

Author:

Amir Shahmoradi, March 22, 2012, 00:00 AM, National Institute for Fusion Studies, The University of Texas at Austin

Definition at line 377 of file pm_timer.F90.

Member Function/Subroutine Documentation

time()

procedure, nopass pm_timer::timerMPI_type::time

See getTime_proc.

Implements pm_timer::timer_type.

Definition at line 379 of file pm_timer.F90.

timerMPI_typer()

type(timerMPI_type) function pm_timer::timerMPI_type::timerMPI_typer

This is the constructor of the timerMPI_type class.

Upon return, the constructor initializes all components of the timer object.
See also the documentation details of pm_timer.

Possible calling interfaces ⛓

use pm_timer, only: timerMPI_type
type(timerMPI_type) :: timer
 
timer = timerMPI_type()

Returns

timer : The output scalar object of class timerMPI_type.

Warning

This constructor requires the MPI library to have been initialized and not finalized.
This condition is verified only if the library is built with the preprocessor macro CHECK_ENABLED=1.

This constructor is available only if the library is built with the preprocessor macro MPI_ENABLED=1.

Remarks

See the documentation of timerMPI_type for example usage.

Final Remarks ⛓

---

If you believe this algorithm or its documentation can be improved, we appreciate your contribution and help to edit this page's documentation and source file on GitHub.
For details on the naming abbreviations, see this page.
For details on the naming conventions, see this page.
This software is distributed under the MIT license with additional terms outlined below.

1. If you use any parts or concepts from this library to any extent, please acknowledge the usage by citing the relevant publications of the ParaMonte library.
   
2. If you regenerate any parts/ideas from this library in a programming environment other than those currently supported by this ParaMonte library (i.e., other than C, C++, Fortran, MATLAB, Python, R), please also ask the end users to cite this original ParaMonte library.
   

This software is available to the public under a highly permissive license.
Help us justify its continued development and maintenance by acknowledging its benefit to society, distributing it, and contributing to it.

Copyright

Computational Data Science Lab

Author:

Amir Shahmoradi, March 22, 2012, 02:51 AM, National Institute for Fusion Studies, The University of Texas at Austin

Definition at line 689 of file pm_timer.F90.

wait()

procedure, nopass pm_timer::timerMPI_type::wait

See setIdle_proc.

Implements pm_timer::timer_type.

Definition at line 380 of file pm_timer.F90.

---

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

• src/fortran/main/pm_timer.F90