SST/macro
Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
sstmac::sw::node_allocator Class Referenceabstract

Strategy type for assigning processes to nodes in a parallel run. More...

#include <node_allocator.h>

Inheritance diagram for sstmac::sw::node_allocator:
Inheritance graph
Collaboration diagram for sstmac::sw::node_allocator:
Collaboration graph

Public Member Functions

void set_topology (hw::topology *top)
 
virtual void init_factory_params (sprockit::sim_parameters *params)
 
virtual std::string to_string () const
 
virtual ~node_allocator () throw ()
 
virtual void allocate (int nnode, const ordered_node_set &available, ordered_node_set &allocation) const =0
 Get nodes. More...
 
- Public Member Functions inherited from sprockit::factory_type
virtual void init_factory_params (sim_parameters *params)
 
virtual void finalize_init ()
 

Protected Member Functions

 node_allocator (parallel_runtime *rt)
 

Protected Attributes

hw::topology * topology_
 
parallel_runtimert_
 

Detailed Description

Strategy type for assigning processes to nodes in a parallel run.

Definition at line 36 of file node_allocator.h.

Constructor & Destructor Documentation

virtual sstmac::sw::node_allocator::~node_allocator ( )
throw (
)
virtual

Referenced by to_string().

sstmac::sw::node_allocator::node_allocator ( parallel_runtime rt)
inlineprotected

Definition at line 67 of file node_allocator.h.

Member Function Documentation

virtual void sstmac::sw::node_allocator::allocate ( int  nnode,
const ordered_node_set available,
ordered_node_set allocation 
) const
pure virtual

Get nodes.

Parameters
nnodenumber of nodes requested
availablethe set of nodes that can be given
allocationreturns the nodes that have been allocated
Returns
Whether the allocation succeeded based on available nodes

Implemented in sstmac::sw::hostname_allocation, sstmac::sw::cart_allocation, sstmac::sw::random_allocation, sstmac::sw::dumpi_allocation, sstmac::sw::first_available_allocation, sstmac::sw::node_id_allocation, and sstmac::sw::coordinate_allocation.

Referenced by to_string().

virtual void sstmac::sw::node_allocator::init_factory_params ( sprockit::sim_parameters *  params)
virtual
void sstmac::sw::node_allocator::set_topology ( hw::topology *  top)
inline

Definition at line 40 of file node_allocator.h.

References init_factory_params(), and topology_.

Here is the call graph for this function:

virtual std::string sstmac::sw::node_allocator::to_string ( ) const
inlinevirtual

Definition at line 48 of file node_allocator.h.

References allocate(), and ~node_allocator().

Here is the call graph for this function:

Member Data Documentation

parallel_runtime* sstmac::sw::node_allocator::rt_
protected

Definition at line 72 of file node_allocator.h.

hw::topology* sstmac::sw::node_allocator::topology_
protected

Definition at line 71 of file node_allocator.h.

Referenced by set_topology().


The documentation for this class was generated from the following file: