petsc4py.PETSc.LogEvent#

class petsc4py.PETSc.LogEvent#

Bases: object

Methods Summary

activate()

Indicate that the event should be logged.

begin(*objs)

Log the beginning of a user event.

deactivate()

Indicate that the event should not be logged.

end(*objs)

Log the end of a user event.

getActive()

Source code at petsc4py/PETSc/Log.pyx:542

getActiveAll()

Source code at petsc4py/PETSc/Log.pyx:572

getName()

Source code at petsc4py/PETSc/Log.pyx:504

getPerfInfo([stage])

Get the performance information about the given event in the given event.

setActive(flag)

Indicate whether or not the event should be logged.

setActiveAll(flag)

Turn on logging of all events.

Attributes Summary

active

active_all

id

name

Methods Documentation

activate()#

Indicate that the event should be logged.

Logically collective.

Source code at petsc4py/PETSc/Log.pyx:518

Return type:

None

begin(*objs)#

Log the beginning of a user event.

Collective.

Parameters:

*objs – objects associated with the event

Return type:

None

Source code at petsc4py/PETSc/Log.pyx:465

deactivate()#

Indicate that the event should not be logged.

Logically collective.

Source code at petsc4py/PETSc/Log.pyx:530

Return type:

None

end(*objs)#

Log the end of a user event.

Collective.

Parameters:

*objs – Objects associated with the event.

Return type:

None

See also

PetscLogEventEnd

Source code at petsc4py/PETSc/Log.pyx:484

getActive()#

Source code at petsc4py/PETSc/Log.pyx:542

getActiveAll()#

Source code at petsc4py/PETSc/Log.pyx:572

getName()#

Source code at petsc4py/PETSc/Log.pyx:504

getPerfInfo(stage=None)#

Get the performance information about the given event in the given event.

Not collective.

Parameters:

stage (int | None) – The stage number.

Returns:

info – This structure is filled with the performance information.

Return type:

dict

Source code at petsc4py/PETSc/Log.pyx:603

setActive(flag)#

Indicate whether or not the event should be logged.

Logically collective.

Parameters:

flag (bool) – Activate or deactivate the event.

Return type:

None

Source code at petsc4py/PETSc/Log.pyx:546

setActiveAll(flag)#

Turn on logging of all events.

Logically collective.

Parameters:

flag (bool) – Activate (if True) or deactivate (if False) the logging of all events.

Return type:

None

Source code at petsc4py/PETSc/Log.pyx:576

Attributes Documentation

active#
active_all#
id#
name#