From e568daaa305c979a54a64ce157364a4b26019009 Mon Sep 17 00:00:00 2001 From: Thomas Haschka Date: Fri, 23 Mar 2018 16:26:36 +0100 Subject: [PATCH] added a readme --- README.md | 31 +++++++++++++++++++++++++++++++ 1 file changed, 31 insertions(+) diff --git a/README.md b/README.md index ad2f9a8..955dc41 100644 --- a/README.md +++ b/README.md @@ -1 +1,32 @@ # FEM +This is a simple finite element solver, solving hexaheadral elements with +bubble functions. A complete documentation is shown in +doc/doc.pdf +The code is tested to compile using gcc on divers linux systems. + +Type make + +Watch the sample in sample.input + +Type ./hex_fem_solver sample.input and you are ready to go. + +LICENSE +(c) 2018 Thomas Haschka + +This software is provided 'as-is', without any express or implied +warranty. In no event will the authors be held liable for any damages +arising from the use of this software. + +Permission is granted to anyone to use this software for any purpose, +including commercial applications, and to alter it and redistribute it +freely, subject to the following restrictions: + + The origin of this software must not be misrepresented; you must + not claim that you wrote the original software. If you use this + software in a product, an acknowledgment in the product + documentation would be appreciated but is not required. + + Altered source versions must be plainly marked as such, and must + not be misrepresented as being the original software. + + This notice may not be removed or altered from any source distribution.