pyiron_contrib.protocol.primitive.two_state module

class pyiron_contrib.protocol.primitive.two_state.AnyVertex(name=None)

Bases: BoolVertex

Checks if any of the vertices in the list are true, and prints a custom string for any vertex that is true.

Input attributes:

vertices (list): The list of vertices. print_strings (list): The list of strings to print should the associated vertex be true.

command(vertices, print_strings)

The command method controls the physics

class pyiron_contrib.protocol.primitive.two_state.BoolVertex(name=None)

Bases: PrimitiveVertex

This is a class of commands designed to branch the graph based on a binary check. They do not have

Attributes

run()

class pyiron_contrib.protocol.primitive.two_state.IsGEq(name=None)

Bases: BoolVertex

Checks if an input value is greater than or equal to a target threshold. Vertex state switches from ‘false’ to ‘true’ when the target exceeds the threshold. Input attributes:

target (float/int): The value being checked. (Default is numpy infinity.) threshold (float/int): What it’s being checked against. (Default is zero.)

command(target=inf, threshold=0)

The command method controls the physics

class pyiron_contrib.protocol.primitive.two_state.IsLEq(name=None)

Bases: BoolVertex

Checks if an input value is less than or equal to a target threshold. Vertex state switches from ‘false’ to ‘true’ when the target exceeds the threshold.

Input attributes:

target (float/int): The value being checked. (Default is zero.) threshold (float/int): What it’s being checked against. (Default is numpy infinity.)

command(target, threshold)

The command method controls the physics

class pyiron_contrib.protocol.primitive.two_state.ModIsZero(name=None)

Bases: BoolVertex

Checks if the target value mod some number is zero.

Input attributes:

target (int): The value being checked. mod (int): The modulo to use.

command(target, mod)

The command method controls the physics