Changes between Version 2 and Version 3 of DirectoryBreakdown


Ignore:
Timestamp:
01/31/13 22:21:19 (12 years ago)
Author:
Jonathan
Comment:

Legend:

Unmodified
Added
Removed
Modified
  • DirectoryBreakdown

    v2 v3  
     1= Directory Breakdown =
    12The AstroBEAR source code is organized into several subdirectories that each contain modules designed to handle a particular aspect of the code. 
    23
     
    2627}
    2728}}}
    28 
    29 Here is a very brief description of each directory.
    30  * tree - Contains modules that define the AMR tree structures as well as various routines for manipulating the AMR tree.
    31  * data - Contains modules that define the data structures associated with each grid or patch as well as operations for synchronizing the data, and for performing operations on the data.
    32  * particle - Contains modules that define the data structures associated with Lagrangian particles, and routines for performing operations on particles.
    33  * amr - Contains control routines for advancing the AMR dataset in time.
    34  * distribution - Contains routines for distributing workloads over multiple processors.
    35  * communication - Contains routines for performing communication needed to synchronize data across processors.
    36  * hyperbolic - Contains routines for performing conservative hyperbolic advances.
    37  * elliptic - Contains routines for solving linear systems of equations such as poisson's equation used by the self-gravity module.
    38  * explicit - Contains routines for solving parabolic equations through explicit sub-cycling
    39  * physics - Contains definitions and functions related to the particular equations being solved.
    40  * io - Contains routines for writing and reading simulation data to disk.
    41  * modules - Contains various routines for controlling initial and boundary conditions
    42  * source - Contains various routines for applying source terms.
    43  * processing - Contains routines for analyzing the data and producing various data products.
    44  * layouts - Contains modules for mapping AMR datasets onto uniform subgrids.
    45  * threads - Contains modules for handling threading of level advances.
     29== What is in each directory ==
     30 * '''tree''' - Contains modules that define the AMR tree structures as well as various routines for manipulating the AMR tree.
     31 * '''data''' - Contains modules that define the data structures associated with each grid or patch as well as operations for synchronizing the data, and for performing operations on the data.
     32 * '''particle''' - Contains modules that define the data structures associated with Lagrangian particles, and routines for performing operations on particles.
     33 * '''amr''' - Contains control routines for advancing the AMR dataset in time.
     34 * '''distribution''' - Contains routines for distributing workloads over multiple processors.
     35 * '''communication''' - Contains routines for performing communication needed to synchronize data across processors.
     36 * '''hyperbolic''' - Contains routines for performing conservative hyperbolic advances.
     37 * '''elliptic''' - Contains routines for solving linear systems of equations such as poisson's equation used by the self-gravity module.
     38 * '''explicit''' - Contains routines for solving parabolic equations through explicit sub-cycling
     39 * '''physics''' - Contains definitions and functions related to the particular equations being solved.
     40 * '''io''' - Contains routines for writing and reading simulation data to disk.
     41 * '''modules''' - Contains various routines for controlling initial and boundary conditions
     42 * '''source''' - Contains various routines for applying source terms.
     43 * '''processing''' - Contains routines for analyzing the data and producing various data products.
     44 * '''layouts''' - Contains modules for mapping AMR datasets onto uniform subgrids.
     45 * '''threads''' - Contains modules for handling threading of level advances.