$Header: /var/cvs/mbdyn/mbdyn/mbdyn-1.0/modules/README,v 1.14 2017/01/12 14:46:55 masarati Exp $
MBDyn (C) is a multibody analysis code.
http://www.mbdyn.org

Copyright (C) 1996-2017

Pierangelo Masarati	<masarati@aero.polimi.it>
Paolo Mantegazza	<mantegazza@aero.polimi.it>

Dipartimento di Ingegneria Aerospaziale - Politecnico di Milano
via La Masa, 34 - 20156 Milano, Italy
http://www.aero.polimi.it

Changing this copyright notice is forbidden.

This program is free software; you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation (version 2 of the License).


This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
GNU General Public License for more details.

You should have received a copy of the GNU General Public License
along with this program; if not, write to the Free Software
Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA



The `modules' directory contains user-defined modules (originally,
user-defined elements).  To enable user-defined modules:

  - make sure MBDyn is configured with --enable-runtime-loading
  - create a subdirectory `module-<user>' in directory `modules'
  - create a (set of) source file(s) implementing the user-defined
    module; the file `module-<user>.<ext>' must be present, where
    `<ext>' is based on the language (.c, .cc, .f, .f90 should work
    for C, C++, F77, F90 respectively).
  - if required, copy Makefile.template in `module-<user>'
    as Makefile.inc and add the other dependencies
  - configure the module for build using `--with-module=<user>',
    where `<user>' is a whitespace separated list of modules.

For instance, to enable the `module-template' user-defined module,
add `--with-module=template' to your configure command.