module-template2.cc

Go to the documentation of this file.

/* $Header: /var/cvs/mbdyn/mbdyn/mbdyn-1.0/modules/module-template2/module-template2.cc,v 1.9 2017/01/12 14:58:10 masarati Exp $ */
/*
 * MBDyn (C) is a multibody analysis code.
 * http://www.mbdyn.org
 *
 * Copyright (C) 1996-2017
 *
 * Pierangelo Masarati  <masarati@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
 */

#include "mbconfig.h"           /* This goes first in every *.c,*.cc file */

#include <iostream>
#include <cfloat>

#include "dataman.h"
#include "userelem.h"

class ModuleTemplate
: virtual public Elem, public UserDefinedElem {
private:
        // add private data

public:
        ModuleTemplate(unsigned uLabel, const DofOwner *pDO,
                DataManager* pDM, MBDynParser& HP);
        virtual ~ModuleTemplate(void);

        virtual void Output(OutputHandler& OH) const;
        virtual void WorkSpaceDim(integer* piNumRows, integer* piNumCols) const;
        VariableSubMatrixHandler& 
        AssJac(VariableSubMatrixHandler& WorkMat,
                doublereal dCoef, 
                const VectorHandler& XCurr,
                const VectorHandler& XPrimeCurr);
        SubVectorHandler& 
        AssRes(SubVectorHandler& WorkVec,
                doublereal dCoef,
                const VectorHandler& XCurr, 
                const VectorHandler& XPrimeCurr);
        unsigned int iGetNumPrivData(void) const;
        int iGetNumConnectedNodes(void) const;
        void GetConnectedNodes(std::vector<const Node *>& connectedNodes) const;
        void SetValue(DataManager *pDM, VectorHandler& X, VectorHandler& XP,
                SimulationEntity::Hints *ph);
        std::ostream& Restart(std::ostream& out) const;
        virtual unsigned int iGetInitialNumDof(void) const;
        virtual void 
        InitialWorkSpaceDim(integer* piNumRows, integer* piNumCols) const;
        VariableSubMatrixHandler&
        InitialAssJac(VariableSubMatrixHandler& WorkMat, 
                      const VectorHandler& XCurr);
        SubVectorHandler& 
        InitialAssRes(SubVectorHandler& WorkVec, const VectorHandler& XCurr);
};

ModuleTemplate::ModuleTemplate(
        unsigned uLabel, const DofOwner *pDO,
        DataManager* pDM, MBDynParser& HP)
: Elem(uLabel, flag(0)),
UserDefinedElem(uLabel, pDO)
{
        // help
        if (HP.IsKeyWord("help")) {
                silent_cout(
"                                                                       \n"
"Module:        template2                                               \n"
"Author:        Pierangelo Masarati <masarati@aero.polimi.it>           \n"
"Organization:  Dipartimento di Ingegneria Aerospaziale                 \n"
"               Politecnico di Milano                                   \n"
"               http://www.aero.polimi.it/                              \n"
"                                                                       \n"
"       All rights reserved                                             \n"
                        << std::endl);

                if (!HP.IsArg()) {
                        /*
                         * Exit quietly if nothing else is provided
                         */
                        throw NoErr(MBDYN_EXCEPT_ARGS);
                }
        }

        // do something useful
}

ModuleTemplate::~ModuleTemplate(void)
{
        // destroy private data
        NO_OP;
}

void
ModuleTemplate::Output(OutputHandler& OH) const
{
        // should do something useful
        NO_OP;
}

void
ModuleTemplate::WorkSpaceDim(integer* piNumRows, integer* piNumCols) const
{
        *piNumRows = 0;
        *piNumCols = 0;
}

VariableSubMatrixHandler& 
ModuleTemplate::AssJac(VariableSubMatrixHandler& WorkMat,
        doublereal dCoef, 
        const VectorHandler& XCurr,
        const VectorHandler& XPrimeCurr)
{
        // should do something useful
        WorkMat.SetNullMatrix();

        return WorkMat;
}

SubVectorHandler& 
ModuleTemplate::AssRes(SubVectorHandler& WorkVec,
        doublereal dCoef,
        const VectorHandler& XCurr, 
        const VectorHandler& XPrimeCurr)
{
        // should do something useful
        WorkVec.ResizeReset(0);

        return WorkVec;
}

unsigned int
ModuleTemplate::iGetNumPrivData(void) const
{
        return 0;
}

int
ModuleTemplate::iGetNumConnectedNodes(void) const
{
        return 0;
}

void
ModuleTemplate::GetConnectedNodes(std::vector<const Node *>& connectedNodes) const
{
        connectedNodes.resize(0);
}

void
ModuleTemplate::SetValue(DataManager *pDM,
        VectorHandler& X, VectorHandler& XP,
        SimulationEntity::Hints *ph)
{
        NO_OP;
}

std::ostream&
ModuleTemplate::Restart(std::ostream& out) const
{
        return out << "# ModuleTemplate: not implemented" << std::endl;
}

unsigned int
ModuleTemplate::iGetInitialNumDof(void) const
{
        return 0;
}

void 
ModuleTemplate::InitialWorkSpaceDim(
        integer* piNumRows,
        integer* piNumCols) const
{
        *piNumRows = 0;
        *piNumCols = 0;
}

VariableSubMatrixHandler&
ModuleTemplate::InitialAssJac(
        VariableSubMatrixHandler& WorkMat, 
        const VectorHandler& XCurr)
{
        // should not be called, since initial workspace is empty
        ASSERT(0);

        WorkMat.SetNullMatrix();

        return WorkMat;
}

SubVectorHandler& 
ModuleTemplate::InitialAssRes(
        SubVectorHandler& WorkVec,
        const VectorHandler& XCurr)
{
        // should not be called, since initial workspace is empty
        ASSERT(0);

        WorkVec.ResizeReset(0);

        return WorkVec;
}

extern "C" int
module_init(const char *module_name, void *pdm, void *php)
{
        UserDefinedElemRead *rf = new UDERead<ModuleTemplate>;

        if (!SetUDE("template2", rf)) {
                delete rf;

                silent_cerr("module-template2: "
                        "module_init(" << module_name << ") "
                        "failed" << std::endl);

                return -1;
        }

        return 0;
}