ppmd.state module¶
-
class
ppmd.state.BaseMDState(*args, **kwargs)¶ Bases:
objectCreate an empty state to which particle properties such as position, velocities are added as attributes.
-
as_func(name)¶ Returns a function handle to evaluate the required attribute.
- Parameters
name (str) – Name of attribute.
- Returns
Callable that returns the value of attribute at the time of calling.)
-
broadcast_data_from(rank=0)¶
-
cell_decompose(cell_width)¶
-
check_npart_total()¶ Check no particles have been lost
-
check_position_consistency()¶
-
property
domain¶
-
filter_on_domain_boundary()¶ Remove particles that do not reside in this subdomain. State requires a domain and a PositionDat
-
gather_data_on(rank=0)¶
-
get_cell_to_particle_map()¶
-
get_npart_local_func()¶
-
get_position_dat()¶
-
invalidate_lists()¶
-
modify()¶
-
move_to_neighbour(ids_directions_list=None, dir_send_totals=None, shifts=None)¶
-
property
npart¶
-
property
npart_local¶ - Returns
Local number of particles
-
rebuild_cell_to_particle_maps()¶
-
remove_by_slot(slots)¶
-
scatter_data_from(rank)¶
-
sum_npart_local()¶ Sum npart_local across all ranks
-
-
class
ppmd.state.State(*args, **kwargs)¶ Bases:
ppmd.state.BaseMDState