Discovering OpenSees:

Surfing the Waves of OpenSees

Adding your Code to OpenSees
Frank McKenna
[email protected]
http://opensees.berkeley.edu/AddingYourCode.pdf
Sponsored by:
NEES through NEEScomm
Pacific Earthquake Engineering Research Center
National Science Foundation
 Outline
Introduction
Adding a New Material to OpenSees.exe
Adding a New Integrator to OpenSees.exe
Summary & Conclusions

NOTE: I HOPE NOT TO GET BOGGED

DOWN IN C++ ISSUES .. THIS IS NOT
A WEBINAR ON HOW TO PROGRAM!
 Traditional Finite Element
Software
Commercial fe codes are large complex
software containing over one million lines of code.
They are closed-source but do allow new
element and material routines to be added. (at
least the serious ones do)
They are slow to change as hardware changes
and they do not allow researchers to play with
other equally important aspects of the code.
They do not promote the active sharing of new
code.
 Numerical Computation
Algorithms & Solvers Models
Material, Element

Information Technology
Database, Visualization, Frameworks,
Parallel & Grid/Network libraries
Building Blocks for Modern Simulation
 OpenSees Goals
To use modern software techniques to evolve an extensible
finite element software platform for earthquake engineering that
would encompass both structural & geotechnical engineering
and be able to change with the rapidly changing hardware
resources.

To provide a common analytical research framework for

researchers to educate students & share new knowledge.

To foster a mechanism whereby new research could be

disseminated quickly to industry for testing and adoption.
 OpenSees Classes
To achieve these goals we developed an open-source
framework for the development of sequential and parallel
finite element applications. This framework we call OpenSees.

The framework contains many classes provided by ourselves

and many many others that allows you to build finite element
applications.

One example of which is the interpreted finite element

application, OpenSees.exe. Commands/Script

Output
 OpenSees Abstract Classes

Parallel&Distributed

Currently over 1000 classes (modules)!

 THE ADVANTAGE OF A
SOFTWARE FRAMEWORK
SUCH AS OPENSEES IS THAT
YOU DONT HAVE TO
UNDERSTAND ALL OF IT TO
BUILD APPLICATIONS OR
MAKE CONTRIBUTIONS
YOU JUST NEED TO
UNDERSTAND THAT PART
THAT CONCERNS YOU
OPENSEES FEM ABSTRACT
CLASSES
 Framework Contains both Abstract
Classes & Concrete Subclasses

Material Element Integrator

Uniaxial nD Section Truss StaticIntegrator

ZeroLength LoadControl
ElasticBeamColumn DispControl
ArcLength
ForceBeamColumn

DispBeamColumn
Elastic TransientIntegrator
Elastic BeamWithHinges
ElasticPP Elastic CentralDifference
Fiber Quad (many forms)
Hardening J2 Newmark
Shell
Concrete DruckerPrager HHT
Brick(many forms)
Steel FluidSolidPorous GeneralizedAlhpa
Joint
Hysteretic PressureMultiYield(dependent, independent) NewmarkExplicit
Contact
PY-TZ-QZ TRBDF2
Parallel AlphaOS
(>100 element classes)
Series (>35 classes)
Gap
Fatigue (over 250 material classes)
 Unknown Class Type
When OpenSees.exe is running and it
comes across a class type it knows nothing
about BEFORE GIVING AN ERROR IT
WILL TRY AND LOAD A LIBRARY OF
THAT CLASSES NAME. If it cannot find
a library of the appropriate name or the
procedure of the appropriate name in the
library it will FAIL. Commands/Script

Output
To Add a New Class you must:
1) Provide Code that meets the Interface
of the appropriate super-class
2) you must BUILD THE LIBRARY
3) make it accessible to the program.

WHILE C++ IS THE GLUE LANGUAGE

THAT HOLDS OPENSEES TOGETHER
YOUR CODE DOES NOT HAVE TO BE
WRITTEN IN C++.
C and FORTRAN OPTIONS ARE ALSO
AVAILABLE
class UniaxialMaterial : public Material Must be overridden by
{
public:
UniaxialMaterial(int tag, int classTag);
subclass, pure virtual
virtual ~UniaxialMaterial();

virtual int setTrialStrain(double strain, double strainRate = 0.0) = 0;

virtual double getStrain(void) = 0;
virtual double getStress(void) = 0;
virtual double getTangent(void) = 0;
virtual double getInitialtangent(void) =0;

virtual int commitState(void) = 0;

virtual int revertToLastCommit(void) = 0;

Can be overridden by subclass

virtual int revertToStart(void) = 0;

virtual UniaxialMaterial *getCopy(void) = 0;

virtual Response *setResponse(const char **argv, int argc,OPS_Stream &theOutput);

virtual int getResponse(int responseID, Information &info);
virtual void Print(OPS_Stream &s, int flag =0);

virtual int sendSelf(int commitTag, Channel &theChannel)=0;

virtual int recvSelf(int commitTag, Chanel &theChannel, FEM_ObjectBroker &theBroker)=0;
// THERE ARE SOME OTHERS .. BUT THESE ARE PURE VIRTUAL ONES THAT MUST BE PROVIDED
protected:
private:
};
 Adding New Code
For those new to Programming NEVER EVER NEVER START
WITH AN EMPTY FILE .. TAKE SOMETHING SIMILAR THAT
WORKS AND MAKE CHANGES TO THAT FILE.

We provide C++, C and Fortran examples on-line using svn

svn://opensees.berkeley.edu/usr/local/svn/OpenSees/trunk/DEVELOPER
TortoiseSVN for Windows Users

your
 Source Code Tree in
DEVELOPER
Makefile
WindowsInstructions
UnixInstructions

core integrator recorder material element element

Trapezoidal.h
Trapezoidal.cpp cpp c fortran cpp c fortran

ElasticPPcpp.h elasticPPc.c elasticPPf.f

ElasticPPcpp.cpp example1.tcl example1.tcl
example1.tcl
 class ElasticPPcpp: public UniaxialMaterial {
public:
Material ElasticPPcpp(int tag, double e, double eyp);
ElasticPPcpp();
Name ~ ElasticPPcpp();
material input properties
int setTrialStrain(double strain, double strainRate=0.0);
double getStrain(void);
double getStress(void);
double getTangent(void);
double getInitialTangent(void);

int commitState(void);
int revertToLastCommit(void);
int revertToStart(void);
UniaxialMaterial *getCopy(void);
int sendSelf(int commitTag, Channel &theChannel);
int recvSelf(int commitTag, Channel &theChannel, FEM_ObjectBroker &theBroker);
void Print(OPS_Stream &s, int flag = 0);
private: data unique to
double fyp, fyn; // pos & neg yield stress
double ezero, E,ep; // init strain, elastic mod
material includes:
double ep; // plastic strain at last commit Material parameters,
double trialStrain, trialStress, trialTangent; & State variables
double commitStrain, commitStress, commitTangent;
};
ElasticPPcpp::ElasticPPcpp(int tag, double e, double eyp)
:UniaxialMaterial(tag, 0),
ezero(0), E(e), ep(0.0) trialStrain(0.0),trialStress(0.0),trialTangent(e),
commitStreain(0.0),commitStress(0.0),commitTangent(e)
{
fyp=E*eyp;
fyn = -fyp;
}
ElasticPPcpp::ElasticPPcpp()
:UniaxialMaterial(tag, 0)
fyp(0),fyn(0),ezero(0), E(0),ep(0),
trialStrain(0.0),trialStress(0.0),trialTangent(0),
commitStrain(0.0),commitStress(0.0),commitTangent(e){
}
ElasticPPcpp::~ElasticPPcpp
{
// does nothing .. No memory to clean up
}
UniaxialMaterial *ElasticPPcpp::getCopy(void)
{
ElasticPPcpp *theCopy = new ElasticPPcpp(this->getTag(), E, fyp/E);
return theCopy;
};
 Hardest Method to Write
ElasticPPcpp::setTrialStrain(double strain, double strainRate)
{
if (fabs(trialStrain - strain) < DBL_EPSILON)
return 0;
trialStrain = strain;
double sigtrial; // trial stress
double f; // yield function
// compute trial stress
sigtrial = E * ( trialStrain - ezero - ep );
// evaluate yield function
if ( sigtrial >= 0.0 )
f = sigtrial - fyp;
else
f = -sigtrial + fyn;
double fYieldSurface = - E * DBL_EPSILON;
if ( f <= fYieldSurface ) {
// elastic
trialStress = sigtrial;
trialTangent = E;
} else {
// plastic
if ( sigtrial > 0.0 ) {
trialStress = fyp;
} else {
trialStress = fyn;
}
trialTangent = 0.0;
}

return 0;
}
double
ElasticPPcpp::getStrain(void)
{
return trialStrain;
}

double
ElasticPPcpp::getStress(void)
{
return trialStress;
}

double
ElasticPPcpp::getTangent(void)
{
return trialTangent;
}

int
ElasticPPcpp::revertToLastCommit(void)
{
trialStrain = commitStrain;
trialTangent = commitTangent;
trialStress = commitStress;

return 0;
}
OPS_Export void * Interpreter looking for this function in lib
OPS_ElasticPPcpp()
{ You can give yourself some
if (numElasticPPcpp == 0) {
opserr << "ElasticPPcpp unaxialKUDOS, e.g.byplease
material - Written reference
fmk UC Berkeley\n;

}
numElasticPPcpp =1; if you used this
// Pointer to a uniaxial material that will be returned
UniaxialMaterial *theMaterial = 0;
int iData[1];
double dData[2];
int numData; parse the script for
three material parameters
numData = 1;
if (OPS_GetIntInput(&numData, iData) != 0) {
opserr << "WARNING invalid uniaxialMaterial ElasticPP tag" << endln;
return 0;
}
numData = 2;
if (OPS_GetDoubleInput(&numData, dData) != 0) {
opserr << "WARNING invalid E & ep\n";
return 0;
} Function returns new material
theMaterial = new ElasticPPcpp(iData[0], dData[0], dData[1]);

return theMaterial;
}
 C & Fortran Procedural
Languages Can Also Be Used
OPS_Export void
elasticPPc (matObj *thisObj, SUBROUTINE ELASTICPPF(matObj,model,strain,tang,stress,isw,err
modelState *model,
double *strain, !DEC$ IF DEFINED (_DLL)
double *tang, !DEC$ ATTRIBUTES DLLEXPORT :: ELASTICPPF
double *stress, !DEC$ END IF
int *isw, use materialTypes
int *result) use materialAPI
{ implicit none
*result = 0; IF (isw.eq.ISW_INIT) THEN

if (*isw == ISW_INIT) { c get the input data - tag? E? eyp?

double dData[2]; numData = 1

int iData[1]; iPtr=>iData;
/* get the input data - tag? E? eyp? */ err = OPS_GetIntInput(numData, iPtr)
int numData = 1; numData = 2
OPS_GetIntInput(&numData, iData); dPtr=>dData;
numData = 2; err = OPS_GetDoubleInput(numData, dPtr)
OPS_GetDoubleInput(&numData, dData);
c Allocate the element state
/* Allocate the element state */ matObj%tag = idata(1)
thisObj->tag = iData[0]; matObj%nparam = 2
thisObj->nParam = 2; /* E, eyp */ matObj%nstate = 2
What Follows are the Steps
required to Build
ElasticPPcpp.dll on a
Windows Machine with
Visual Studio 2010 Installed
 We Will Build the
ElasticPPcpp.dll

Source code and example are in

/DEVELOPER/material/cpp
Create Project

1)File>New>Project
 4.SelectWin32Project

3.SelectWin32

1.GiveDLLnameElasAcPPcpp

5.SelectOK
2.GiveLocaAon
SelectApplicaAonSeGngs
 1.SelectDLL

2.SelectDLL

3.SelectFinish
Add Files To Project

1. RightClickonSourceFiles
2. SelectAddExisAng
3. NavigatetoDEVELOPER/material/cppdirectory
4. SelecttheElasAcPPcpp.cppand.hle
5. SelectAdd
1)SelectBuild>SoluAon
1. RightClickonElasAcPPcppProject
2. SelectProperAes
3. SelectC/C++

IT FAILS!
 4.IncludecoreinaddiAonalincludedirectories

3.SelectAllConguaraAonsfromPullDownMenu

1. SelectC/C++
2. SelectGeneral
1)SelectBuild>SoluAon

IT FAILS!
1. RightClickonSourceFiles
2. SelectAddExisAng
3. NavigatetoDEVELOPER/coredirectory
4. SelecttheAll.cppand.hle
5. SelectAdd
1.SelectBuildSoluAon
Copy ElasticPPcpp.dll from
location into current directory

Now run Example

What Follows are the Steps
required to Build
ElasticPPcpp.so on a Linux
Machine with gcc installed

NOTE: We Will use

NEEShub
for this demonstration
(http://nees.org)
 3 Simple Steps!
1. Download code
svn co svn://opensees.berkeley.edu/usr/local/svn/OpenSees/trunk/OpenSees/Developer Developer

2. cd DEVELOPER/material/cpp
3. type make
if you type ls you should see the .so and you
Can test it using >OpenSees example1.tcl

NOTE: mac users must have xcode installed and

must open DEVELOPER/Makefile.def and switch
comments on lines 1 and 2 before step 3.
1: Download Source Code
2/3: cd to Directory & Type make
Run It
 NEXT SEMINAR
Feb 2012, Topic EITHER be High
Performance Computing and OpenSees
or How To Model Soil-Structure
Interaction.

We will again be using NEEShub for the

demonstration. So get an account if you
dont have one! Its free to everyone.