CappedBondedInteraction.h

Go to the documentation of this file.

//                                                         //
// Copyright (c) 2003-2013 by The University of Queensland //
// Earth Systems Science Computational Centre (ESSCC)      //
// http://www.uq.edu.au/esscc                              //
//                                                         //
// Primary Business: Brisbane, Queensland, Australia       //
// Licensed under the Open Software License version 3.0    //
// http://www.opensource.org/licenses/osl-3.0.php          //
//                                                         //

#ifndef __CAPPEDBONDEDINTERACTION_H
#define __CAPPEDBONDEDINTERACTION_H

// -- project includes --
#include "Model/IGParam.h" // keep this one first - it drags in mpi.h
#include "Model/BondedInteraction.h"
#include "Model/Interaction.h"
#include "Model/Particle.h"
#include "Model/BondedInteractionCpData.h"
#include "Foundation/vec3.h"

// -- I/O includes --
#include <iostream>
using std::ostream;

// -- STL includes --
#include <utility>

using std::pair;

class CCappedBondedIGP : public CBondedIGP 
{

public:
  double m_force_limit; // maximum force

  CCappedBondedIGP();
  CCappedBondedIGP(const std::string &name, int tag, double normalK, double breakDistance,double forceLimit);

  virtual std::string getTypeString() const  {return "CappedBonded"; }
};

class CCappedBondedInteraction : public CBondedInteraction
{
 public: // types
  typedef CCappedBondedIGP ParameterType;

  typedef double (CCappedBondedInteraction::* ScalarFieldFunction)() const;
  typedef pair<bool,double> (CCappedBondedInteraction::* CheckedScalarFieldFunction)() const;
  typedef Vec3 (CCappedBondedInteraction::* VectorFieldFunction)() const;

 protected:
  double m_force_limit; 
  CCappedBondedInteraction(CParticle*,CParticle*);

 public:
  CCappedBondedInteraction();
  CCappedBondedInteraction(
    CParticle *particle1,
    CParticle *particle2,
    const CCappedBondedIGP &params
  );

  virtual ~CCappedBondedInteraction();

  static ScalarFieldFunction getScalarFieldFunction(const string&);
  static CheckedScalarFieldFunction getCheckedScalarFieldFunction(const string&);
  static VectorFieldFunction getVectorFieldFunction(const string&);

  static string getType() {return "CappedBonded";};

  virtual void calcForces();

  friend class TML_PackedMessageInterface;
};

#endif //__CAPPEDBONDEDINTERACTION_H