From bdf112acb5cd05160e660ce0cda8ca5da4703762 Mon Sep 17 00:00:00 2001 From: David Wells Date: Mon, 25 Jul 2022 11:26:54 -0400 Subject: [PATCH] Clean up readme --- cdr/readme.md | 49 ++++++++++++++++++------------------------------- 1 file changed, 18 insertions(+), 31 deletions(-) diff --git a/cdr/readme.md b/cdr/readme.md index 67e1747..95a8721 100644 --- a/cdr/readme.md +++ b/cdr/readme.md @@ -1,43 +1,30 @@ ## Overview I started this project with the intent of better understanding adaptive mesh -refinement, parallel computing, and CMake. In particular, I started -by writing a uniform mesh, single process solver and then ultimately expanded it -into solver/cdr.cc. This example program might be useful to look at -if you want to see: - +refinement, parallel computing, and CMake. In particular, I started by writing a +uniform mesh, single process solver and then ultimately expanded it into +`solver/cdr.cc`. This example program might be useful to look at if you want to see: + +* A more complex `CMake` setup, which builds a shared object library and an + executable +* A simple parallel time stepping problem +* Use of `C++11` lambda functions The other solvers are available [here](http://www.github.com/drwells/dealii-cdr). Unlike the other tutorial programs, I have split this solver into a number of files in nested directories. In particular, I used the following strategy (more-or-less copied [ASPECT](http://aspect.dealii.org)): - - - - - -## Requirements - +* The `common` directory, which hosts files common to the four solvers I wrote + along the way. Most of the source files in `common/source/` are just + *template specializations*; they compile the template code for specific + dimensions and linear algebra (matrix or vector) types. The + `common/include/deal.II-cdr/` directory contains both templates and plain + header files. +* The `solver/` directory contains the actual solver class and strongly + resembles a tutorial program. The file `solver/cdr.cc` just sets up data + structures and then calls routines in `libdeal.II-cdr-common` to populate them + and produce output. ## Compiling and running Like the example programs, run -- 2.39.5