petsc4py.PETSc.LogEvent#

class petsc4py.PETSc.LogEvent#

Bases: object

Logging support.

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`()	Not implemented.
`getActiveAll`()	Not implemented.
`getName`()	The current event name.
`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`	Event activation.
`active_all`	All events activation.
`id`	The log event identifier.
`name`	The current event name.

Methods Documentation

activate()#

Indicate that the event should be logged.

Logically collective.

See also

PetscLogEventActivate

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

Return type:: None

begin(*objs)#

Log the beginning of a user event.

Collective.

Parameters:: *objs – objects associated with the event
Return type:: None

See also

PetscLogEventBegin

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

deactivate()#

Indicate that the event should not be logged.

Logically collective.

See also

PetscLogEventDeactivate

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

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:554

getActive()#

Not implemented.

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

Return type:: bool

getActiveAll()#

Not implemented.

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

Return type:: bool

getName()#

The current event name.

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

Return type:: str

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