Documentation generated by
00001 00002 /** \mainpage Sundance Reference Manual 00003 00004 Sundance is a system for rapid development of parallel finite-element 00005 simulations. A problem can be described using high-level objects that 00006 represent the geometry, equation set, and discretization method; it is 00007 then discretized and solved. 00008 00009 <H3> User's guide </H3> 00010 00011 A user's guide is available in both 00012 <A HREF="../UsersGuide/UsersGuide/index.html"> HTML </A> 00013 and 00014 <A HREF="../UsersGuide/UsersGuide.ps"> postscript </A> forms. 00015 00016 <H3> To Do </H3> 00017 00018 <A HREF="../Src/WishList.html"> Wish list </A> 00019 00020 <H3> Simple examples </H3> 00021 00022 <A HREF="../Src/ExampleIndex.html"> Index of maintained examples </A> 00023 00024 00025 Here are some reasonably well-commented examples. 00026 <UL> 00027 <LI> <a href="heat1D_8cpp-example.html"> solution of Poisson 00028 equation in one dimension </a> 00029 <LI> <a href="heat2D_8cpp-example.html"> solution of Poisson 00030 equation on a simple domain in two dimensions </a> 00031 <LI> <a href="optPoisson1D_8cpp-example.html"> optimal control of Poisson equation 00032 in 1D </a> 00033 <LI> <a href="burgers1D_8cpp-example.html"> solution of Burgers' 00034 equation in one dimension </a> 00035 <LI> <a href="catenary_8cpp-example.html"> solution of Poisson 00036 equation on a simple domain in two dimensions </a> 00037 <LI> <a href="tBirdHeat_8cpp-example.html"> solution of Poisson 00038 equation on a complex geometric domain in two dimensions </a> 00039 <LI> <a href="poissonBoltzmann1D_8cpp-example.html"> serial solution of 00040 Poisson-Boltzmann equation in one dimension, using Newton's method for the nonlinear 00041 solve </a> 00042 </UL> 00043 Other examples are available in the subdirectory examples/Tests. 00044 00045 <H3> Class reference </H3> 00046 00047 In typical applications, the user will need only a small subset of the 00048 classes. Those classes intended for general use are documented in 00049 the <A HREF="group_UserLevelClasses.html"> User Level Class Documentation. </A> 00050 00051 Sundance is designed to be extensible. Advanced users can add their 00052 own objects such as basis functions, cell geometry types, linear solvers, 00053 or I/O file formats. For those who want to extend 00054 Sundance, or who are simply curious about its inner workings, the 00055 internal classes are described in the 00056 <A HREF="group_LowLevelClasses.html"> Low-Level Class Documentation. </A> 00057 00058 00059 00060 00061 00062 */ 00063 00064 /** \example heat1D.cpp */ 00065 /** \example inlinePoissonBoltzmann1D.cpp */ 00066 /** \example heat2D.cpp */ 00067 /** \example tBirdHeat.cpp */ 00068 /** \example burgers1D.cpp */ 00069 /** \example catenary.cpp */ 00070 00071 00072 00073 00074 00075 00076