You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+44-45Lines changed: 44 additions & 45 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -7,50 +7,10 @@ Some of the main contributors are I. Vignon-Clementel, N. Wilson, J. Wan, B. Ste
7
7
8
8
The one-dimensional equations for the flow of a Newtonian, incompressible fluid in a deforming, elastic domain consist of the continuity equation, a single axial momentum balance equation, a constitutive equation, and suitable initial and boundary conditions.
9
9
10
-
## Installation
11
-
12
-
### Prerequisites
13
-
14
-
The following software is required:
15
-
16
-
- Sphinx (HTML Manual)
17
-
- SWIG Interface generator (Python Interface)
18
-
- MPI (mpi4py is used for running parameteric simulations from python)
19
-
- SuperLU_MT (if you would like to use this sparse solver)
20
-
21
-
### Generate makefiles with CMake
22
-
23
-
Out-of-source is the suggested build modality. To do this, first create a build folder (for example "OneDBin") as a sibling of the main source code folder (probably "svOneDSolver")
24
-
25
-
~~~
26
-
mkdir svOneDSolver_build
27
-
~~~
28
-
29
-
Change directory into svOneDSolver_build
30
-
31
-
~~~
32
-
cd svOneDSolver_build
33
-
~~~
34
-
35
-
Now you can use the ccmake (command line) or cmake-gui (Qt-based CMake GUI) to create the make files.
36
-
For example, using ccmake from the OneDBin folder type
37
-
38
-
~~~
39
-
ccmake ../svOneDSolver
40
-
~~~
41
-
42
-
Configure the code until CMake will let you generate the makefiles. Press "g" (ccmake) to generate the makefiles. See below for options
43
-
44
-
To build the code run (within "OneDBin")
45
-
46
-
~~~
47
-
make -j n
48
-
~~~
49
-
50
-
where n is the number of processors you want to use to build.
10
+
## Usage
11
+
Usage assumes that you have built from the source as described below.
51
12
52
13
### Basic usage
53
-
54
14
There are three supported usages for the generated executable.
55
15
* The quotations around the input args are optional
56
16
* Input file paths can be specified as a local file name or an absolute path
@@ -73,9 +33,7 @@ Run the simulation using a JSON input file
73
33
svOneDSolver -jsonInput "<jsonInputFile>.json"
74
34
~~~
75
35
76
-
77
-
### Run tests
78
-
36
+
### Manually run tests
79
37
System and unit tests can be run using ctest and pytest commands.
- MPI (mpi4py is used for running parameteric simulations from python)
94
+
- SuperLU_MT (if you would like to use this sparse solver)
95
+
96
+
### Generate makefiles with CMake
97
+
98
+
Out-of-source is the suggested build modality. To do this, first create a build folder (for example "OneDBin") as a sibling of the main source code folder (probably "svOneDSolver")
99
+
100
+
~~~
101
+
mkdir svOneDSolver_build
102
+
~~~
103
+
104
+
Change directory into svOneDSolver_build
105
+
106
+
~~~
107
+
cd svOneDSolver_build
108
+
~~~
109
+
110
+
Now you can use the ccmake (command line) or cmake-gui (Qt-based CMake GUI) to create the make files.
111
+
For example, using ccmake from the OneDBin folder type
112
+
113
+
~~~
114
+
ccmake ../svOneDSolver
115
+
~~~
116
+
117
+
Configure the code until CMake will let you generate the makefiles. Press "g" (ccmake) to generate the makefiles. See below for options
118
+
119
+
To build the code run (within "OneDBin")
120
+
121
+
~~~
122
+
make -j n
123
+
~~~
124
+
125
+
where n is the number of processors you want to use to build.
0 commit comments