Statistics
| Branch: | Revision:

root / src / sim / parsim / parsimindex.h @ e1750c09

History | View | Annotate | Download (2.11 KB)

1
//==========================================================================
2
//  PARSIMINDEX.H - part of
3
//                     OMNeT++/OMNEST
4
//            Discrete System Simulation in C++
5
//
6
//  Defines modules for documentation generation. Nothing useful for the
7
//  C++ compiler.
8
//
9
//==========================================================================
10

    
11
/*--------------------------------------------------------------*
12
  Copyright (C) 1992-2008 Andras Varga
13
  Copyright (C) 2006-2008 OpenSim Ltd.
14

15
  This file is distributed WITHOUT ANY WARRANTY. See the file
16
  `license' for details on this and other legal matters.
17
*--------------------------------------------------------------*/
18

    
19
/**
20
 * @mainpage \opp Parallel simulation support
21
 *
22
 * This documentation describes the architecture of the distributed
23
 * parallel simulation implementation in \opp.
24
 *
25
 * All classes documented here are used internally -- if you are into
26
 * writing simulation models, there is nothing interesting for you here.
27
 *
28
 * Click the following link for details: @ref Parsim
29
 */
30

    
31
/**
32
 * @defgroup Parsim  Parallel simulation support
33
 *
34
 * Parallel simulation support has a layered architecture, with the
35
 * following layers:
36
 *
37
 *    -# Communications layer, represented by cParsimCommunications.
38
 *    This encapsulates all details of message passing between parts
39
 *    of a program that executes in parallel, and hides details of
40
 *    the communications library (MPI, PVM, ...). Subclasses implemented
41
 *    here are cMPICommunications, cNamedPipeCommunications,
42
 *    cFileCommunications.
43
 *    -# Partition layer, represented by cParsimPartition. This encapsulates
44
 *    the task of distributing the simulation model over several
45
 *    partitions, and handles messaging between these partitions.
46
 *    It relies on layer 1 for this.
47
 *    -# Synchronization layer, represented by cParsimSynchronizer.
48
 *    It encapsulates the different parallel simulation algorithms
49
 *    like the conservative null message algorithm. This layer
50
 *    heavily cooperates with the message scheduler of the simulation.
51
 *
52
 * See corresponding classes for more information.
53
 */
54

    
55