Skip to content

Commit 2126ab6

Browse files
committed
Add a first test. Add a licence
1 parent d64093f commit 2126ab6

21 files changed

+1520
-26
lines changed

CMakeLists.txt

+1
Original file line numberDiff line numberDiff line change
@@ -48,3 +48,4 @@ if(CMAKE_BUILD_TYPE STREQUAL "Coverage")
4848
endif(CMAKE_BUILD_TYPE STREQUAL "Coverage")
4949

5050
add_subdirectory(src)
51+
add_subdirectory(tests)

CeCILL-C_V1-en.txt

+516
Large diffs are not rendered by default.

CeCILL-C_V1-fr.txt

+520
Large diffs are not rendered by default.

LGPL-3.0.txt

+165
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,165 @@
1+
GNU LESSER GENERAL PUBLIC LICENSE
2+
Version 3, 29 June 2007
3+
4+
Copyright (C) 2007 Free Software Foundation, Inc. <https://fsf.org/>
5+
Everyone is permitted to copy and distribute verbatim copies
6+
of this license document, but changing it is not allowed.
7+
8+
9+
This version of the GNU Lesser General Public License incorporates
10+
the terms and conditions of version 3 of the GNU General Public
11+
License, supplemented by the additional permissions listed below.
12+
13+
0. Additional Definitions.
14+
15+
As used herein, "this License" refers to version 3 of the GNU Lesser
16+
General Public License, and the "GNU GPL" refers to version 3 of the GNU
17+
General Public License.
18+
19+
"The Library" refers to a covered work governed by this License,
20+
other than an Application or a Combined Work as defined below.
21+
22+
An "Application" is any work that makes use of an interface provided
23+
by the Library, but which is not otherwise based on the Library.
24+
Defining a subclass of a class defined by the Library is deemed a mode
25+
of using an interface provided by the Library.
26+
27+
A "Combined Work" is a work produced by combining or linking an
28+
Application with the Library. The particular version of the Library
29+
with which the Combined Work was made is also called the "Linked
30+
Version".
31+
32+
The "Minimal Corresponding Source" for a Combined Work means the
33+
Corresponding Source for the Combined Work, excluding any source code
34+
for portions of the Combined Work that, considered in isolation, are
35+
based on the Application, and not on the Linked Version.
36+
37+
The "Corresponding Application Code" for a Combined Work means the
38+
object code and/or source code for the Application, including any data
39+
and utility programs needed for reproducing the Combined Work from the
40+
Application, but excluding the System Libraries of the Combined Work.
41+
42+
1. Exception to Section 3 of the GNU GPL.
43+
44+
You may convey a covered work under sections 3 and 4 of this License
45+
without being bound by section 3 of the GNU GPL.
46+
47+
2. Conveying Modified Versions.
48+
49+
If you modify a copy of the Library, and, in your modifications, a
50+
facility refers to a function or data to be supplied by an Application
51+
that uses the facility (other than as an argument passed when the
52+
facility is invoked), then you may convey a copy of the modified
53+
version:
54+
55+
a) under this License, provided that you make a good faith effort to
56+
ensure that, in the event an Application does not supply the
57+
function or data, the facility still operates, and performs
58+
whatever part of its purpose remains meaningful, or
59+
60+
b) under the GNU GPL, with none of the additional permissions of
61+
this License applicable to that copy.
62+
63+
3. Object Code Incorporating Material from Library Header Files.
64+
65+
The object code form of an Application may incorporate material from
66+
a header file that is part of the Library. You may convey such object
67+
code under terms of your choice, provided that, if the incorporated
68+
material is not limited to numerical parameters, data structure
69+
layouts and accessors, or small macros, inline functions and templates
70+
(ten or fewer lines in length), you do both of the following:
71+
72+
a) Give prominent notice with each copy of the object code that the
73+
Library is used in it and that the Library and its use are
74+
covered by this License.
75+
76+
b) Accompany the object code with a copy of the GNU GPL and this license
77+
document.
78+
79+
4. Combined Works.
80+
81+
You may convey a Combined Work under terms of your choice that,
82+
taken together, effectively do not restrict modification of the
83+
portions of the Library contained in the Combined Work and reverse
84+
engineering for debugging such modifications, if you also do each of
85+
the following:
86+
87+
a) Give prominent notice with each copy of the Combined Work that
88+
the Library is used in it and that the Library and its use are
89+
covered by this License.
90+
91+
b) Accompany the Combined Work with a copy of the GNU GPL and this license
92+
document.
93+
94+
c) For a Combined Work that displays copyright notices during
95+
execution, include the copyright notice for the Library among
96+
these notices, as well as a reference directing the user to the
97+
copies of the GNU GPL and this license document.
98+
99+
d) Do one of the following:
100+
101+
0) Convey the Minimal Corresponding Source under the terms of this
102+
License, and the Corresponding Application Code in a form
103+
suitable for, and under terms that permit, the user to
104+
recombine or relink the Application with a modified version of
105+
the Linked Version to produce a modified Combined Work, in the
106+
manner specified by section 6 of the GNU GPL for conveying
107+
Corresponding Source.
108+
109+
1) Use a suitable shared library mechanism for linking with the
110+
Library. A suitable mechanism is one that (a) uses at run time
111+
a copy of the Library already present on the user's computer
112+
system, and (b) will operate properly with a modified version
113+
of the Library that is interface-compatible with the Linked
114+
Version.
115+
116+
e) Provide Installation Information, but only if you would otherwise
117+
be required to provide such information under section 6 of the
118+
GNU GPL, and only to the extent that such information is
119+
necessary to install and execute a modified version of the
120+
Combined Work produced by recombining or relinking the
121+
Application with a modified version of the Linked Version. (If
122+
you use option 4d0, the Installation Information must accompany
123+
the Minimal Corresponding Source and Corresponding Application
124+
Code. If you use option 4d1, you must provide the Installation
125+
Information in the manner specified by section 6 of the GNU GPL
126+
for conveying Corresponding Source.)
127+
128+
5. Combined Libraries.
129+
130+
You may place library facilities that are a work based on the
131+
Library side by side in a single library together with other library
132+
facilities that are not Applications and are not covered by this
133+
License, and convey such a combined library under terms of your
134+
choice, if you do both of the following:
135+
136+
a) Accompany the combined library with a copy of the same work based
137+
on the Library, uncombined with any other library facilities,
138+
conveyed under the terms of this License.
139+
140+
b) Give prominent notice with the combined library that part of it
141+
is a work based on the Library, and explaining where to find the
142+
accompanying uncombined form of the same work.
143+
144+
6. Revised Versions of the GNU Lesser General Public License.
145+
146+
The Free Software Foundation may publish revised and/or new versions
147+
of the GNU Lesser General Public License from time to time. Such new
148+
versions will be similar in spirit to the present version, but may
149+
differ in detail to address new problems or concerns.
150+
151+
Each version is given a distinguishing version number. If the
152+
Library as you received it specifies that a certain numbered version
153+
of the GNU Lesser General Public License "or any later version"
154+
applies to it, you have the option of following the terms and
155+
conditions either of that published version or of any later version
156+
published by the Free Software Foundation. If the Library as you
157+
received it does not specify a version number of the GNU Lesser
158+
General Public License, you may choose any version of the GNU Lesser
159+
General Public License ever published by the Free Software Foundation.
160+
161+
If the Library as you received it specifies that a proxy can decide
162+
whether future versions of the GNU Lesser General Public License shall
163+
apply, that proxy's public statement of acceptance of any version is
164+
permanent authorization for you to choose that version for the
165+
Library.

README.md

+29
Original file line numberDiff line numberDiff line change
@@ -1 +1,30 @@
11
# MFrontGenericBehaviourSupport
2+
3+
This project aims at proving tools (functions, classes, bindings,
4+
etc...) to handle behaviours written using `MFront` generic interface.
5+
6+
Those tools are meant to be used by (`FEM`, `FFT`, etc.) solver
7+
developers. This tools are *not* linked to the `TFEL` libraries.
8+
Permissive licences have been chosen to allow integration in open-source
9+
and proprietary codes.
10+
11+
## The `MFrontGenericInterface` `C++` library
12+
13+
The project is build around the `MFrontGenericInterface` library. This
14+
library provides two main functions:
15+
16+
- load `MFront` behaviours from external shared libraries and retrieve
17+
meta data about the behaviour through the `mfront::behaviour::load`
18+
function. All the relevant information about the behaviour are stored
19+
in the `mfront::behaviour::Description` class.
20+
- provide generic function to handle material data (such as internal
21+
state variables) at integration points and call `MFront` behaviours.
22+
23+
## Bindings
24+
25+
The following bindings are under consideration:
26+
27+
- `python` binding
28+
- `c` binding
29+
- `fortran90` binding
30+
- `octave` binding

include/MFront/Behaviour/Behaviour.hxx

+9-2
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,15 @@
11
/*!
22
* \file Behaviour.hxx
33
* \brief
4-
* \author th202608
5-
* \date 20/06/2018
4+
* \author Thomas Helfer
5+
* \date 19/06/2018
6+
* \copyright (C) Copyright Thomas Helfer 2018.
7+
* Use, modification and distribution are subject
8+
* to one of the following licences:
9+
* - GNU Lesser General Public License (LGPL), Version 3.0. (See accompanying
10+
* file LGPL-3.0.txt)
11+
* - CECILL-C, Version 1.0 (See accompanying files
12+
* CeCILL-C_V1-en.txt and CeCILL-C_V1-fr.txt).
613
*/
714

815
#ifndef LIB_MFRONT_BEHAVIOUR_BEHAVIOUR_HXX

include/MFront/Behaviour/Description.hxx

+8-1
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,13 @@
33
* \brief
44
* \author Thomas Helfer
55
* \date 19/06/2018
6+
* \copyright (C) Copyright Thomas Helfer 2018.
7+
* Use, modification and distribution are subject
8+
* to one of the following licences:
9+
* - GNU Lesser General Public License (LGPL), Version 3.0. (See accompanying
10+
* file LGPL-3.0.txt)
11+
* - CECILL-C, Version 1.0 (See accompanying files
12+
* CeCILL-C_V1-en.txt and CeCILL-C_V1-fr.txt).
613
*/
714

815
#ifndef LIB_MFRONT_BEHAVIOUR_DESCRIPTION_HXX
@@ -20,7 +27,7 @@ namespace mfront {
2027
/*!
2128
* \brief structure describing a behaviour
2229
*/
23-
struct Description {
30+
struct MFRONT_EXPORT Description {
2431
//! \behaviour symmetry
2532
enum Symmetry { ISOTROPIC, ORTHOTROPIC };
2633
//! \brief constructor

include/MFront/Behaviour/Hypothesis.hxx

+8-1
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,15 @@
11
/*!
22
* \file Hypothesis.hxx
33
* \brief
4-
* \author th202608
4+
* \author Thomas Helfer
55
* \date 19/06/2018
6+
* \copyright (C) Copyright Thomas Helfer 2018.
7+
* Use, modification and distribution are subject
8+
* to one of the following licences:
9+
* - GNU Lesser General Public License (LGPL), Version 3.0. (See accompanying
10+
* file LGPL-3.0.txt)
11+
* - CECILL-C, Version 1.0 (See accompanying files
12+
* CeCILL-C_V1-en.txt and CeCILL-C_V1-fr.txt).
613
*/
714

815
#ifndef LIB_MFRONT_BEHAVIOUR_HYPOTHESIS_HXX

include/MFront/Behaviour/MaterialData.hxx

+8-1
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,15 @@
11
/*!
22
* \file MaterialData.hxx
33
* \brief
4-
* \author th202608
4+
* \author Thomas Helfer
55
* \date 19/06/2018
6+
* \copyright (C) Copyright Thomas Helfer 2018.
7+
* Use, modification and distribution are subject
8+
* to one of the following licences:
9+
* - GNU Lesser General Public License (LGPL), Version 3.0. (See accompanying
10+
* file LGPL-3.0.txt)
11+
* - CECILL-C, Version 1.0 (See accompanying files
12+
* CeCILL-C_V1-en.txt and CeCILL-C_V1-fr.txt).
613
*/
714

815
#ifndef LIB_MFRONT_BEHAVIOUR_DATA_HXX

include/MFront/Behaviour/Variable.hxx

+8-1
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,15 @@
11
/*!
22
* \file MFront/Behaviour/Variable.hxx
33
* \brief
4-
* \author th202608
4+
* \author Thomas Helfer
55
* \date 19/06/2018
6+
* \copyright (C) Copyright Thomas Helfer 2018.
7+
* Use, modification and distribution are subject
8+
* to one of the following licences:
9+
* - GNU Lesser General Public License (LGPL), Version 3.0. (See accompanying
10+
* file LGPL-3.0.txt)
11+
* - CECILL-C, Version 1.0 (See accompanying files
12+
* CeCILL-C_V1-en.txt and CeCILL-C_V1-fr.txt).
613
*/
714

815
#ifndef LIB_MFRONT_BEHAVIOUR_VARIABLE_HXX

include/MFront/Config.hxx

+8-1
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,15 @@
11
/*!
22
* \file include/MFront/Config.hxx
33
* \brief
4-
* \author th202608
4+
* \author Thomas Helfer
55
* \date 19/06/2018
6+
* \copyright (C) Copyright Thomas Helfer 2018.
7+
* Use, modification and distribution are subject
8+
* to one of the following licences:
9+
* - GNU Lesser General Public License (LGPL), Version 3.0. (See accompanying
10+
* file LGPL-3.0.txt)
11+
* - CECILL-C, Version 1.0 (See accompanying files
12+
* CeCILL-C_V1-en.txt and CeCILL-C_V1-fr.txt).
613
*/
714

815
#ifndef LIB_MFRONT_CONFIG_HXX

include/MFront/LibrariesManager.hxx

+7
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,13 @@
33
* \brief
44
* \author Thomas Helfer
55
* \date 20/06/2018
6+
* \copyright (C) Copyright Thomas Helfer 2018.
7+
* Use, modification and distribution are subject
8+
* to one of the following licences:
9+
* - GNU Lesser General Public License (LGPL), Version 3.0. (See accompanying
10+
* file LGPL-3.0.txt)
11+
* - CECILL-C, Version 1.0 (See accompanying files
12+
* CeCILL-C_V1-en.txt and CeCILL-C_V1-fr.txt).
613
*/
714

815
#ifndef LIB_MFRONT_LIBRARIESMANAGER_HXX

include/MFront/Raise.hxx

+8-7
Original file line numberDiff line numberDiff line change
@@ -2,13 +2,14 @@
22
* \file include/MFront/Raise.hxx
33
* \brief declaration of the `raise` function.
44
* \author Thomas Helfer
5-
* \date 19/09/2017
6-
* \copyright Copyright (C) 2006-2018 CEA/DEN, EDF R&D. All rights
7-
* reserved.
8-
* This project is publicly released under either the GNU GPL Licence
9-
* or the CECILL-A licence. A copy of thoses licences are delivered
10-
* with the sources of TFEL. CEA or EDF may also distribute this
11-
* project under specific licensing conditions.
5+
* \date 20/06/2018
6+
* \copyright (C) Copyright Thomas Helfer 2018.
7+
* Use, modification and distribution are subject
8+
* to one of the following licences:
9+
* - GNU Lesser General Public License (LGPL), Version 3.0. (See accompanying
10+
* file LGPL-3.0.txt)
11+
* - CECILL-C, Version 1.0 (See accompanying files
12+
* CeCILL-C_V1-en.txt and CeCILL-C_V1-fr.txt).
1213
*/
1314

1415
#ifndef LIB_MFRONT_RAISE_HXX

include/MFront/Raise.ixx

+8-7
Original file line numberDiff line numberDiff line change
@@ -2,13 +2,14 @@
22
* \file include/MFront/Raise.ixx
33
* \brief
44
* \author Thomas Helfer
5-
* \date 20/09/2017
6-
* \copyright Copyright (C) 2006-2018 CEA/DEN, EDF R&D. All rights
7-
* reserved.
8-
* This project is publicly released under either the GNU GPL Licence
9-
* or the CECILL-A licence. A copy of thoses licences are delivered
10-
* with the sources of TFEL. CEA or EDF may also distribute this
11-
* project under specific licensing conditions.
5+
* \date 20/06/2018
6+
* \copyright (C) Copyright Thomas Helfer 2018.
7+
* Use, modification and distribution are subject
8+
* to one of the following licences:
9+
* - GNU Lesser General Public License (LGPL), Version 3.0. (See accompanying
10+
* file LGPL-3.0.txt)
11+
* - CECILL-C, Version 1.0 (See accompanying files
12+
* CeCILL-C_V1-en.txt and CeCILL-C_V1-fr.txt).
1213
*/
1314

1415
#ifndef LIB_MFRONT_RAISE_IXX

0 commit comments

Comments
 (0)