First commit.

Author: jacobwilliams

.gitignore

@@ -0,0 +1,34 @@
+# Compiled Object files
+*.slo
+*.lo
+*.o
+*.obj
+
+# Precompiled Headers
+*.gch
+*.pch
+
+# Compiled Dynamic libraries
+*.so
+*.dylib
+*.dll
+
+# Fortran module files
+*.mod
+
+# Compiled Static libraries
+*.lai
+*.la
+*.a
+*.lib
+
+# Executables
+*.exe
+*.out
+*.app
+
+# Directories
+build
+doc
+lib
+bin

LICENSE

@@ -0,0 +1,31 @@
+Copyright (c) 2000-2008, Roland Schmehl.
+Copyright (c) 2017, Jacob Williams.
+
+All rights reserved.
+
+* Redistribution and use in source and binary forms, with or without
+modification, are permitted provided that the following conditions are
+met:
+
+* Redistributions of source code must retain the above copyright notice,
+this list of conditions and the following disclaimer.
+
+* Redistributions in binary form must reproduce the above copyright
+notice, this list of conditions and the following disclaimer in the
+documentation and/or other materials provided with the distribution.
+
+* Neither the name of the copyright holder nor the names of its
+contributors may be used to endorse or promote products derived from
+this software without specific prior written permission.
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
+"AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
+LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
+A PARTICULAR PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE COPYRIGHT
+OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
+SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
+LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
+DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
+THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
+(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
+OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

README.md

@@ -0,0 +1,129 @@
+### Description
+
+This function parser module is intended for applications where a set of
+mathematical fortran-style expressions is specified at runtime and is
+then evaluated for a large number of variable values. This is done by
+compiling the set of function strings into byte code, which is
+interpreted efficiently for the various variable values.
+
+### Basic usage
+
+#### Module Import
+
+In all program units where you want to use the function parser
+you must import the module by:
+
+```fortran
+use function_parser
+```
+
+This command imports only 3 public types: `fparser`, `fparser_array`, and
+`list_of_errors`, which are explained in the following. The remainder of the
+module is hidden to the calling program.
+
+#### Function parsing
+
+A single function string `funcstr` can be parsed (checked and compiled) into
+bytecode by calling the `fparser` class method subroutine `parse`:
+
+```fortran
+call me%parse(funcstr, var, case_sensitive, error_msg)
+```
+
+The variable names as they appear in the string `funcstr` have to be passed
+in the one-dimensional string array `var` (zero size of `var` is acceptable).
+The number of variables is implicitly passed by the dimension of this array.
+For some notes on the syntax of the function string see below.
+
+To parse an array of function strings, you can use the `fparser_array` class
+method `parse` in a similar manner.
+
+#### Function evaluation
+
+The function value is evaluated for a specific set of variable values
+by calling the `fparser` class method subroutine `evaluate`:
+
+```fortran
+call me%evaluate(val, res, error_msg)
+```
+
+The variable values are passed in the one-dimensional array `val` which must
+have the same dimension as array `var`.
+
+To evaluate an array of function strings, you can use the `fparser_array` class
+method `evaluate` in a similar manner.
+
+#### Cleanup
+
+To free the memory and destroy a variable of type `fparser` or `fparser_array`,
+use the `destroy` method:
+
+```fortran
+call me%destroy()
+```
+
+### Error handling
+
+Errors are reported using the `error_msg` output of the `parse` and `evaluate`
+methods. This is variable of type `list_of_errors`, which is also exported
+by the `function_parser` module.
+
+* An error in the function parsing step leads to a detailed error message
+(Type and position of error) returned in the `error_msg` output of the
+`parse` method.
+
+* An error during function evaluation returns a function value of 0.0 and
+an error message returned in the `error_msg` output of the
+`evaluate` method.
+
+To check if a `list_of_errors` class contains a message, use the
+`has_errors` method.
+The `print` method can also be used to print the error messages.
+
+### Function string syntax
+
+Although they have to be passed as array elements of the same declared
+length (Fortran restriction), the variable names can be of arbitrary
+actual length for the parser. Parsing for variables is case sensitive.
+
+The syntax of the function string is similar to the Fortran convention.
+Mathematical Operators recognized are `+,` `-,` `*,` `/,` `**` or alternatively `^,`
+whereas symbols for brackets must be `()`.
+
+The function parser recognizes the (single argument) Fortran intrinsic
+functions `abs`, `exp`, `log10`, `log`, `sqrt`, `sinh`, `cosh`, `tanh`,
+`sin`, `cos`, `tan`, `asin`, `acos`, `atan`. Parsing for intrinsic
+functions is case INsensitive.
+
+Operations are evaluated in the correct order:
+
+* `()      `    expressions in brackets first
+* `-A      `    unary minus (or plus)
+* `A**B A^B`    exponentiation (`A` raised to the power `B`)
+* `A*B  A/B`    multiplication and division
+* `A+B  A-B`    addition and subtraction
+
+The function string can contain integer or real constants. To be recognized
+as explicit constants these must conform to the format
+
+`[+|-][nnn][.nnn][e|E|d|D[+|-]nnn]`
+
+where `nnn` means any number of digits. The mantissa must contain at least
+one digit before or following an optional decimal point. Valid exponent
+identifiers are 'e', 'E', 'd' or 'D'. If they appear they must be followed
+by a valid exponent!
+
+### Notes
+
+* The precision of real numbers can be adapted to the calling program by
+  adjusting the KIND parameter `wp` in the module.
+
+### Credits
+
+* This code is based on Fortran 95 function parser v1.1 by Roland Schmehl
+  <[email protected]>. The source code is available
+  from [here](http://fparser.sourceforge.net).
+* The function parser concept is based on a C++ class library written by
+  Juha Nieminen <[email protected]> available from [here](http://warp.povusers.org/FunctionParser/).
+* The code has been updated to Fortran 2008 by Jacob Williams. Development
+  continues on [GitHub](https://github.com/jacobwilliams/fortran_function_parser).

build.sh

@@ -0,0 +1,49 @@
+#!/bin/bash
+
+#
+#  Simple build script.
+#
+#  Requires: FoBiS and Ford
+#
+
+MODCODE='function_parser.f90'       # module file name
+LIBOUT='libfparser.a'               # name of library
+DOCDIR='./doc/'                     # build directory for documentation
+SRCDIR='./src/'                     # library source directory
+TESTSRCDIR='./src/tests/'           # unit test source directory
+BINDIR='./bin/'                     # build directory for unit tests
+LIBDIR='./lib/'                     # build directory for library
+FORDMD='fortran_function_parser.md' # FORD config file name
+
+#compiler flags:
+
+FCOMPILER='gnu' #Set compiler to gfortran
+FCOMPILERFLAGS='-c -O2 -std=f2008'
+
+#build using FoBiS:
+
+if hash FoBiS.py 2>/dev/null; then
+
+    echo "Building library..."
+
+    FoBiS.py build -compiler ${FCOMPILER} -cflags "${FCOMPILERFLAGS}" -dbld ${LIBDIR} -s ${SRCDIR} -dmod ./ -dobj ./ -t ${MODCODE} -o ${LIBOUT} -mklib static -colors
+
+    echo "Building test programs..."
+
+    FoBiS.py build -compiler ${FCOMPILER} -cflags "${FCOMPILERFLAGS}" -dbld ${BINDIR} -s ${TESTSRCDIR} -dmod ./ -dobj ./ -colors -libs ${LIBDIR}${LIBOUT} --include ${LIBDIR}
+
+else
+    echo "FoBiS.py not found! Cannot build library. Install using: sudo pip install FoBiS.py"
+fi
+
+# build the documentation using FORD:
+
+if hash ford 2>/dev/null; then
+
+    echo "Building documentation..."
+
+    ford ${FORDMD}
+
+else
+    echo "Ford not found! Cannot build documentation. Install using: sudo pip install ford"
+fi

fortran_function_parser.md

@@ -0,0 +1,18 @@
+project: fortran_function_parser
+project_dir: ./src
+output_dir: ./doc
+project_github: https://github.com/jacobwilliams/fortran_function_parser
+summary: Modern Fortran Function Parser
+author: Jacob Williams
+github: https://github.com/jacobwilliams
+predocmark_alt: >
+predocmark: <
+docmark_alt:
+docmark: !
+display: public
+         protected
+source: true
+graph: true
+extra_mods: iso_fortran_env:https://gcc.gnu.org/onlinedocs/gfortran/ISO_005fFORTRAN_005fENV.html
+
+{!README.md!}