README.md 3.6 KB
Newer Older
1
2
3
4
5
<!--
   |--------------------------------------------------------------------------|
   | =========                 |                                              |
   | \\      /  F ield         | OpenFOAM: The Open Source CFD Toolbox        |
   |  \\    /   O peration     |                                              |
Mark Olesen's avatar
Mark Olesen committed
6
   |   \\  /    A nd           | Copyright (C) 2016-2017 OpenCFD Ltd.         |
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
   |    \\/     M anipulation  |                                              |
   |--------------------------------------------------------------------------|
  -->

---

# OpenFOAM&reg; ThirdParty

OpenFOAM depends to a certain extent on third-party libraries
(*opensource only*). It also provides some interfaces to *opensource* or
*proprietary* libraries. This third-party package contains configurations and
scripts for building third-party packages. It should normally only be used in
conjunction with the corresponding OpenFOAM version.

## Configuration of Third-Party Versions

23
24
For most of the build scripts, the default software version
is provided by an appropriate OpenFOAM `etc/config.sh/...` entry.
25
26
27
28
This approach avoids duplicate entries for the default versions and
ensures the best overall consistency between the OpenFOAM installation
and its corresponding third-party installation.

29
30
31
32
Nonethess, the distributed make scripts can generally be used for a
variety of versions of the third-party libraries, with the software
version specified on the command-line.

33
34
35
36
---

## Before Starting

37
38
39
40
41
42
43
0. Review the [system requirements](http://www.openfoam.com/documentation/system-requirements.php)
   and decide on the following:
   * compiler type/version (you may need a third-party compiler installation).
   * MPI type/version.
   * ParaView type/version.
   * CMake type/version, ...
1. Adjust the OpenFOAM `etc/bashrc`, `etc/config.sh/...` or equivalent
44
45
   `prefs.sh` files to reflect your preferred
   [configuration](https://develop.openfoam.com/Development/OpenFOAM-plus/blob/develop/etc/README.md).
46
2. Source the updated OpenFOAM environment
47
48
49

---

50
51
52
53
## Building

Many components of ThirdParty are *optional* or are invoked
automatically as part of the top-level OpenFOAM `Allwmake`.
54
Nonetheless it may be necessary or useful to build particular
55
56
ThirdParty components prior to building OpenFOAM itself.

57
### Build Sequence
58
59

1. `makeGcc` _or_ `makeLLVM` *(optional)*
60
61
2. `makeCmake`  *(optional)*
3. `Allwmake`
62
   - This will be automatically invoked by the top-level OpenFOAM `Allwmake`.
63
4. `makeParaView`  *(optional but highly recommended)*
64
5. Any other additional optional components
65
66


67
### Build Details
68

69
70
71
72
73
74
75
More details can be found the ThirdParty
[BUILD.md](https://develop.openfoam.com/Development/ThirdParty-plus/blob/develop/BUILD.md)
information.

Some configuration details can be found the OpenFOAM
[etc/README.md](https://develop.openfoam.com/Development/OpenFOAM-plus/blob/develop/etc/README.md)
information.
Mark Olesen's avatar
Mark Olesen committed
76
77
78
79
80

<!-- OpenFOAM -->

[link AddOns]: https://develop.openfoam.com/Community/OpenFOAM-addOns
[link community-projects]: http://www.openfoam.com/community/projects.php
81

82
---
83
84
85
86

<!-- Standard Footer -->
## Additional OpenFOAM Links

Mark Olesen's avatar
Mark Olesen committed
87
88
89
90
- [Community AddOns][link AddOns] repository
- [Collaborative and Community-based Developments][link community-projects]
- [Download](http://www.openfoam.com/download) and
  [installation instructions](http://www.openfoam.com/code/build-guide.php)
91
- [Documentation](http://www.openfoam.com/documentation)
Mark Olesen's avatar
Mark Olesen committed
92
- [Reporting bugs/issues](http://www.openfoam.com/code/bug-reporting.php) (including bugs/suggestions/feature requests) in OpenFOAM
93
94
95
96
- [Contacting OpenCFD](http://www.openfoam.com/contact)

---

Mark Olesen's avatar
Mark Olesen committed
97
Copyright 2016-2017 OpenCFD Ltd