mpacts.commands.monitors. debug

In order to be able to use this module import it like this:

import mpacts.commands.monitors.debug
#or assign it to a shorter name
import mpacts.commands.monitors.debug as deb

FindNaNCommand

class mpacts.commands.monitors.debug.FindNaNCommand

Bases: mpacts.core.command.Command, mpacts.core.baseobject.BaseObject

Finds NaN and inf in specified array and throws ET::BadValue
Default location: ‘loop_cmds/post_contact_cmds’
  • Required keywords:
    • array — Array to checked for NaN/infs.
  • Optional keywords:
    • gate (default value = ET::ChildProperty const*) — Can decide to (temporarily) not execute the command in a CommandList. (Default is ExecuteAlways)
object __init__(tuple args, dict kwds) :
args: name, parent kwds: array, [gate]
FindNaNCommand(name, parent, **kwargs)

OutOfRangeCommand

class mpacts.commands.monitors.debug.OutOfRangeCommand

Bases: mpacts.core.command.Command, mpacts.core.baseobject.BaseObject

Finds values under/over the specified min and max values in a specified array and throws ET::BadValue
Default location: ‘loop_cmds/post_contact_cmds’
  • Required keywords:
    • array — Array to checked for out of range values.
    • max — Maximum allowed value. GIVE AS STRING WITH COMMAS & CORRECT LENGTH!
    • min — Minimum allowed value. GIVE AS STRING WITH COMMAS & CORRECT LENGTH!
  • Optional keywords:
    • gate (default value = ET::ChildProperty const*) — Can decide to (temporarily) not execute the command in a CommandList. (Default is ExecuteAlways)
object __init__(tuple args, dict kwds) :
args: name, parent kwds: array, min, max, [gate]
OutOfRangeCommand(name, parent, **kwargs)

PCStatisticsCommand

class mpacts.commands.monitors.debug.PCStatisticsCommand

Bases: mpacts.core.command.Command, mpacts.core.baseobject.BaseObject

PCStatistics command
Default location: ‘loop_cmds/pre_contact_cmds/Periodic_BC_CopyToGhost_PeriodicBoundary1D’
  • Required keywords:
    • pc — Particle container on which the command is applied
  • Optional keywords:
    • gate (default value = ET::ChildProperty const*) — Can decide to (temporarily) not execute the command in a CommandList. (Default is ExecuteAlways)
    • predicate (default value = None) — Predicate that will decide whether this command is executed for a specific particle, when absent the command is executed for every particle.
object __init__(tuple args, dict kwds) :
args: name, parent kwds: pc, [gate, predicate]
PCStatisticsCommand(name, parent, **kwargs)

PrintIndexArrayCommand

class mpacts.commands.monitors.debug.PrintIndexArrayCommand

Bases: mpacts.core.command.Command, mpacts.core.baseobject.BaseObject

Debug print of index array.
Has no default location.
  • Required keywords:
    • array_name — Array to be printed.
    • command — Pointer to command after(before) which the print command will be placed.
    • pc — Particle container on which the command is applied
  • Optional keywords:
    • before (default value = 0) — By default we are placed after the command.
    • gate (default value = ET::ChildProperty const*) — Can decide to (temporarily) not execute the command in a CommandList. (Default is ExecuteAlways)
    • predicate (default value = None) — Predicate that will decide whether this command is executed for a specific particle, when absent the command is executed for every particle.
object __init__(tuple args, dict kwds) :
args: name, parent kwds: pc, array_name, command, [gate, predicate, before]
PrintIndexArrayCommand(name, parent, **kwargs)

PrintScalarArrayCommand

class mpacts.commands.monitors.debug.PrintScalarArrayCommand

Bases: mpacts.core.command.Command, mpacts.core.baseobject.BaseObject

Debug print of scalar array.
Has no default location.
  • Required keywords:
    • array_name — Array to be printed.
    • command — Pointer to command after(before) which the print command will be placed.
    • pc — Particle container on which the command is applied
  • Optional keywords:
    • before (default value = 0) — By default we are placed after the command.
    • gate (default value = ET::ChildProperty const*) — Can decide to (temporarily) not execute the command in a CommandList. (Default is ExecuteAlways)
    • predicate (default value = None) — Predicate that will decide whether this command is executed for a specific particle, when absent the command is executed for every particle.
object __init__(tuple args, dict kwds) :
args: name, parent kwds: pc, array_name, command, [gate, predicate, before]
PrintScalarArrayCommand(name, parent, **kwargs)

PrintVectorArrayCommand

class mpacts.commands.monitors.debug.PrintVectorArrayCommand

Bases: mpacts.core.command.Command, mpacts.core.baseobject.BaseObject

Debug print of vector array.
Has no default location.
  • Required keywords:
    • array_name — Array to be printed.
    • command — Pointer to command after(before) which the print command will be placed.
    • pc — Particle container on which the command is applied
  • Optional keywords:
    • before (default value = 0) — By default we are placed after the command.
    • gate (default value = ET::ChildProperty const*) — Can decide to (temporarily) not execute the command in a CommandList. (Default is ExecuteAlways)
    • predicate (default value = None) — Predicate that will decide whether this command is executed for a specific particle, when absent the command is executed for every particle.
object __init__(tuple args, dict kwds) :
args: name, parent kwds: pc, array_name, command, [gate, predicate, before]
PrintVectorArrayCommand(name, parent, **kwargs)