gmPhysics.h

Go to the documentation of this file.

/************************************************************************
**
** Copyright (C) 2014 by Carlos Augusto Teixera Mendes
** All rights reserved.
**
** This file is part of the "GeMA" software. It's use should respect
** the terms in the license agreement that can be found together
** with this source code.
** It is provided AS IS, with NO WARRANTY OF ANY KIND,
** INCLUDING THE WARRANTY OF DESIGN, MERCHANTABILITY AND FITNESS FOR
** A PARTICULAR PURPOSE.
**
************************************************************************/
 
#ifndef _GEMA_PHYSICS_H_
#define _GEMA_PHYSICS_H_
 
#include "gmPluginObject.h"
#include "gmPluginCategory.h"
#include "gmUserFunction.h"
 
class GmCellMesh;
class GmCellAccessor;
class GmBoundaryCondition;
class GmBoundaryConditionAccessor;
class GmContactBoundaryCondition;
class GmContactBoundaryConditionAccessor;
class GmDiscontinuitySet;
class GmDiscontinuityAccessor;
 
class GMC_API_EXPORT GmPhysics : public GmPluginObject
{
public:
  GmPhysics(GmSimulationData* simulation, QString id, QString description, const GmLogCategory& logger);
  virtual ~GmPhysics();
 
  // Comments on the base class
  virtual const char* pluginCategory() const { return GM_PLUGIN_PHYSICS; }
 
  virtual void printParameters(const GmLogCategory& logger);
 
  GmCellAccessor* propertyAccessor(GmCellMesh* mesh, QString stdPropertyName, QString msgDescription,
                                   LuaTable& table, Unit desiredUnit, bool required,
                                   int type = -1, int nlin = -1, int ncol = -1,
                                   bool canBeFunction = true, bool ignoreWarnings = false)
  {
    return propertyAccessorAux(mesh, stdPropertyName, msgDescription, table, desiredUnit, false,
                               required, type, nlin, ncol, canBeFunction, ignoreWarnings);
  }
 
  GmCellAccessor* extPropertyAccessor(GmCellMesh* mesh, QString stdPropertyName, QString msgDescription,
                                      LuaTable& table, Unit desiredUnit, bool required,
                                      int type = -1, int nlin = -1, int ncol = -1,
                                      bool canBeFunction = true, bool ignoreWarnings = false)
  {
    return propertyAccessorAux(mesh, stdPropertyName, msgDescription, table, desiredUnit, true,
                               required, type, nlin, ncol, canBeFunction, ignoreWarnings);
  }
 
  GmDiscontinuityAccessor* discontinuityPropertyAccessor(GmDiscontinuitySet* discSet, QString stdPropertyName,
                                   QString msgDescription, LuaTable& table, Unit desiredUnit, 
                                   bool required, int type = -1, int nlin = -1, int ncol = -1,
                                   bool ignoreWarnings = false)
  {
    return discontinuityPropertyAccessorAux(discSet, stdPropertyName, msgDescription, table, desiredUnit, 
                                            false, required, type, nlin, ncol, ignoreWarnings);
  }
 
  GmDiscontinuityAccessor* extDiscontinuityPropertyAccessor(GmDiscontinuitySet* discSet, QString stdPropertyName,
                                   QString msgDescription, LuaTable& table, Unit desiredUnit, 
                                   bool required, int type = -1, int nlin = -1, int ncol = -1,
                                   bool ignoreWarnings = false)
  {
    return discontinuityPropertyAccessorAux(discSet, stdPropertyName, msgDescription, table, desiredUnit, 
                                            true, required, type, nlin, ncol, ignoreWarnings);
  }
 
protected:
 
  GmCellAccessor* cellAttributeAccessor(GmCellMesh* mesh, QString stdAttributeName, QString msgDescription,
                                        LuaTable& table, Unit desiredUnit, bool required, int type = -1, 
                                        int nlin = -1, int ncol = -1, int history = -1, bool canBeFunction = true, 
                                        bool create = false, QString createFormat = "", int createHistory = -1, 
                                        bool ignoreWarnings = false);
 
  GmCellAccessor* cellDataAccessor(GmCellMesh* mesh, QString stdAttributeName, QString msgDescription,
                                   LuaTable& table, Unit desiredUnit, bool required, int type = -1,
                                   int nlin = -1, int ncol = -1, int history = -1, bool canBeFunction = true,
                                   bool ignoreWarnings = false);
 
  GmValueAccessor* nodeAttributeAccessor(GmCellMesh* mesh, QString stdAttributeName, QString msgDescription,
                                         LuaTable& table, Unit desiredUnit, bool required, int type = -1, 
                                         int nlin = -1, int ncol = -1, int history = -1, bool canBeFunction = true, 
                                         bool create = false, QString createFormat = "", int createHistory = -1, 
                                         bool ignoreWarnings = false);
 
  GmValueAccessor* nodeDataAccessor(GmCellMesh* mesh, QString stdAttributeName, QString msgDescription,
                                    LuaTable& table, Unit desiredUnit, bool required, int type = -1,
                                    int nlin = -1, int ncol = -1, int history = -1, bool canBeFunction = true,
                                    bool ignoreWarnings = false);
 
  GmBoundaryConditionAccessor* boundaryAccessor(const GmBoundaryCondition* bc, QString stdPropertyName, QString msgDescription,
                                                Unit desiredUnit, bool required, int type = -1, 
                                                int nlin = -1, int ncol = -1, bool canBeFunction = true, bool ignoreWarnings = false);
 
  GmContactBoundaryConditionAccessor* contactAccessor(const GmContactBoundaryCondition* bc, QString stdPropertyName, QString msgDescription,
                                                      Unit desiredUnit, bool required, int type = -1, 
                                                      int nlin = -1, int ncol = -1, bool canBeFunction = true, bool ignoreWarnings = false);
 
  QString dofFromStateVar(const GmCellMesh* mesh, QString stdStateVarName, QString msgDescription,
                          LuaTable& table, QVector<int>& dofList, Unit resultUnit, bool required,
                          GmValueSetKind svType, int type = -1, int nlin = -1, int ncol = -1, 
                          bool ignoreWarnings = false);
 
  QString translateId(QString stdName, LuaTable& table) const;
 
  bool checkType    (GmValueInfo* info, int type, int nlin, int ncol, bool required, bool ignoreWarnings, 
                     QString dataTypeMsg, QString msgDescription) const;
  bool checkFunction(GmValueInfo* info, bool canBeFunction, bool required, bool ignoreWarnings,
                     QString dataTypeMsg, QString msgDescription) const;
  bool checkHistory (GmValueInfo* info, int history, bool required, bool ignoreWarnings,
                     QString dataTypeMsg, QString msgDescription) const;
 
  GmValueInfo* createValueInfo(QString id, QString description, Unit desiredUnit, GmValueSetKind kind,
                               int type, int nlin, int ncol, QString createFormat, int createHistory) const;
 
private:
  GmCellAccessor* propertyAccessorAux(GmCellMesh* mesh, QString stdPropertyName, QString msgDescription,
                                      LuaTable& table, Unit desiredUnit, bool acceptsCellAttributes,
                                      bool required, int type, int nlin, int ncol, bool canBeFunction, 
                                      bool ignoreWarnings);
 
  GmDiscontinuityAccessor* discontinuityPropertyAccessorAux(GmDiscontinuitySet* discSet, QString stdPropertyName,
                                      QString msgDescription, LuaTable& table, Unit desiredUnit, 
                                      bool acceptsCellAttributes, bool required,
                                      int type, int nlin, int ncol, bool ignoreWarnings);
};
 
 
class GMC_API_EXPORT GmPhysicsUserFunctions: public GmPluginObject
{
public:
  GmPhysicsUserFunctions(GmSimulationData* simulation, QString id, QString description, const GmLogCategory& logger);
  virtual ~GmPhysicsUserFunctions();
 
  // Comments on the base class
  virtual const char* pluginCategory() const { return GM_PLUGIN_PHYSICS; }
 
  // Comments on the base class
  virtual const char* pluginType() const { return "userFunctions"; }
 
  virtual bool loadPrivateData(LuaTable& table);
  virtual void printParameters(const GmLogCategory& logger);
 
  void setMesh(const GmMesh* mesh) { _mesh = mesh; }
 
  virtual QStringList functionList() const = 0;
 
  virtual GmCUserMethod function(QString funcName) const = 0;
 
protected:
  const GmMesh* mesh() const { return _mesh; }
 
private:
  const GmMesh* _mesh; 
};
 
 
#endif