module-template.cc File Reference

#include "mbconfig.h"
#include <iostream>
#include <cfloat>
#include <dataman.h>
#include "loadable.h"

Include dependency graph for module-template.cc:

Go to the source code of this file.

Classes
struct	module_template

Functions
static void *	read (LoadableElem *pEl, DataManager *pDM, MBDynParser &HP)
static unsigned int	i_get_num_dof (const LoadableElem *pEl)
static DofOrder::Order	set_dof (const LoadableElem *, unsigned int i)
static void	output (const LoadableElem *pEl, OutputHandler &OH)
static std::ostream &	restart (const LoadableElem *pEl, std::ostream &out)
static void	work_space_dim (const LoadableElem *pEl, integer *piNumRows, integer *piNumCols)
static VariableSubMatrixHandler &	ass_jac (LoadableElem *pEl, VariableSubMatrixHandler &WorkMat, doublereal dCoef, const VectorHandler &XCurr, const VectorHandler &XPrimeCurr)
static void	ass_mats (LoadableElem *pEl, VariableSubMatrixHandler &WorkMatA, VariableSubMatrixHandler &WorkMatB, const VectorHandler &XCurr, const VectorHandler &XPrimeCurr)
static SubVectorHandler &	ass_res (LoadableElem *pEl, SubVectorHandler &WorkVec, doublereal dCoef, const VectorHandler &XCurr, const VectorHandler &XPrimeCurr)
static void	before_predict (const LoadableElem *pEl, VectorHandler &X, VectorHandler &XP, VectorHandler &XPrev, VectorHandler &XPPrev)
static void	after_predict (const LoadableElem *pEl, VectorHandler &X, VectorHandler &XP)
static void	update (LoadableElem *pEl, const VectorHandler &X, const VectorHandler &XP)
static void	after_convergence (const LoadableElem *, const VectorHandler &, const VectorHandler &)
static unsigned int	i_get_initial_num_dof (const LoadableElem *pEl)
static void	initial_work_space_dim (const LoadableElem *pEl, integer *piNumRows, integer *piNumCols)
static VariableSubMatrixHandler &	initial_ass_jac (LoadableElem *pEl, VariableSubMatrixHandler &WorkMat, const VectorHandler &XCurr)
static SubVectorHandler &	initial_ass_res (LoadableElem *pEl, SubVectorHandler &WorkVec, const VectorHandler &XCurr)
static void	set_value (const LoadableElem *pEl, DataManager *pDM, VectorHandler &X, VectorHandler &XP, SimulationEntity::Hints *ph)
static void	set_initial_value (const LoadableElem *pEl, VectorHandler &X)
static unsigned int	i_get_num_priv_data (const LoadableElem *pEl)
static unsigned int	i_get_priv_data_idx (const LoadableElem *pEl, const char *s)
static doublereal	d_get_priv_data (const LoadableElem *pEl, unsigned int i)
static void	destroy (LoadableElem *pEl)
static int	i_get_num_connected_nodes (const LoadableElem *pEl)
static void	get_connected_nodes (const LoadableElem *pEl, std::vector< const Node * > &connectedNodes)

Variables
static struct LoadableCalls	lc
void *	calls = &lc

Function Documentation

static void after_convergence ( const LoadableElem *  , const VectorHandler &  , const VectorHandler &    )

static

Definition at line 220 of file module-template.cc.

References DEBUGCOUTFNAME.

{
        DEBUGCOUTFNAME("after_convergence");
}

static void after_predict ( const LoadableElem *  pEl, VectorHandler &  X, VectorHandler &  XP  )

static

Definition at line 200 of file module-template.cc.

References DEBUGCOUTFNAME.

{
        DEBUGCOUTFNAME("after_predict");
}

static VariableSubMatrixHandler& ass_jac ( LoadableElem *  pEl, VariableSubMatrixHandler &  WorkMat, doublereal  dCoef, const VectorHandler &  XCurr, const VectorHandler &  XPrimeCurr  )

static

Definition at line 104 of file module-template.cc.

References DEBUGCOUTFNAME, LoadableElem::pGetData(), FullSubMatrixHandler::ResizeReset(), VariableSubMatrixHandler::SetFull(), and LoadableElem::WorkSpaceDim().

{  
        DEBUGCOUTFNAME("ass_jac");
        integer iNumRows = 0;
        integer iNumCols = 0;
        pEl->WorkSpaceDim(&iNumRows, &iNumCols);
        
        FullSubMatrixHandler& WM = WorkMat.SetFull();
        WM.ResizeReset(iNumRows, iNumCols);

#if 0
        module_template* p = (module_template *)pEl->pGetData();
#endif /* 0 */
        
        /*
         * set sub-matrix indices and coefs
         */
        
        return WorkMat;
}

Here is the call graph for this function:

static void ass_mats ( LoadableElem *  pEl, VariableSubMatrixHandler &  WorkMatA, VariableSubMatrixHandler &  WorkMatB, const VectorHandler &  XCurr, const VectorHandler &  XPrimeCurr  )

static

Definition at line 132 of file module-template.cc.

References DEBUGCOUTFNAME, LoadableElem::pGetData(), FullSubMatrixHandler::ResizeReset(), VariableSubMatrixHandler::SetFull(), and LoadableElem::WorkSpaceDim().

{  
        DEBUGCOUTFNAME("ass_mats");
        integer iNumRows = 0;
        integer iNumCols = 0;
        pEl->WorkSpaceDim(&iNumRows, &iNumCols);
        
        FullSubMatrixHandler& WMA = WorkMatA.SetFull();
        WMA.ResizeReset(iNumRows, iNumCols);
        
        FullSubMatrixHandler& WMB = WorkMatB.SetFull();
        WMB.ResizeReset(iNumRows, iNumCols);

#if 0
        module_template* p = (module_template *)pEl->pGetData();
#endif /* 0 */
        
        /*
         * set sub-matrix indices and coefs
         */
}

Here is the call graph for this function:

static SubVectorHandler& ass_res ( LoadableElem *  pEl, SubVectorHandler &  WorkVec, doublereal  dCoef, const VectorHandler &  XCurr, const VectorHandler &  XPrimeCurr  )

static

Definition at line 161 of file module-template.cc.

References DEBUGCOUTFNAME, LoadableElem::pGetData(), VectorHandler::Resize(), and LoadableElem::WorkSpaceDim().

{
        DEBUGCOUTFNAME("ass_res");
        integer iNumRows = 0;
        integer iNumCols = 0;
        pEl->WorkSpaceDim(&iNumRows, &iNumCols);
        
        WorkVec.Resize(iNumRows);

#if 0
        module_template* p = (module_template *)pEl->pGetData(); 
#endif /* 0 */
        
        /*
         * set sub-vector indices and coefs
         */
        
        return WorkVec;
}

Here is the call graph for this function:

static void before_predict ( const LoadableElem *  pEl, VectorHandler &  X, VectorHandler &  XP, VectorHandler &  XPrev, VectorHandler &  XPPrev  )

static

Definition at line 188 of file module-template.cc.

References DEBUGCOUTFNAME.

{
        DEBUGCOUTFNAME("before_predict");
}

static doublereal d_get_priv_data ( const LoadableElem *  pEl, unsigned int  i  )

static

Definition at line 330 of file module-template.cc.

References ASSERT, DEBUGCOUTFNAME, WithLabel::GetLabel(), LoadableElem::iGetNumPrivData(), and MBDYN_EXCEPT_ARGS.

{
        DEBUGCOUTFNAME("d_get_priv_data");
        ASSERT(pEl->iGetNumPrivData() > 0);
        if (i > pEl->iGetNumPrivData()) {
                silent_cerr("Module-template Elem(" << pEl->GetLabel() << "): "
                        "illegal private data index " << i << std::endl);
                throw ErrGeneric(MBDYN_EXCEPT_ARGS);
        }
   
        /*
         * return i-th priv data
         */
        return 0.;
}

Here is the call graph for this function:

static void destroy ( LoadableElem *  pEl )

static

Definition at line 347 of file module-template.cc.

References DEBUGCOUTFNAME, LoadableElem::pGetData(), and SAFEDELETE.

{
        DEBUGCOUTFNAME("destroy");

        module_template* p = (module_template *)pEl->pGetData();

        /*
         * delete private data
         */
        
        SAFEDELETE(p);
}

Here is the call graph for this function:

static void get_connected_nodes ( const LoadableElem *  pEl, std::vector< const Node * > &  connectedNodes  )

static

Definition at line 373 of file module-template.cc.

References DEBUGCOUTFNAME, i_get_num_connected_nodes(), and LoadableElem::pGetData().

{
        DEBUGCOUTFNAME("get_connected_nodes");

#if 0
        module_template* p = (module_template *)pEl->pGetData();
#endif /* 0 */

        /*
         * set args according to element connections
         */
        connectedNodes.resize(i_get_num_connected_nodes(pEl));
}

Here is the call graph for this function:

static unsigned int i_get_initial_num_dof ( const LoadableElem *  pEl )

static

Definition at line 228 of file module-template.cc.

References DEBUGCOUTFNAME.

{
        DEBUGCOUTFNAME("i_get_initial_num_dof");
        return 0;
}

static int i_get_num_connected_nodes ( const LoadableElem *  pEl )

static

Definition at line 361 of file module-template.cc.

References DEBUGCOUTFNAME, and LoadableElem::pGetData().

Referenced by get_connected_nodes().

{
        DEBUGCOUTFNAME("i_get_num_connected_nodes");

#if 0
        module_template* p = (module_template *)pEl->pGetData();
#endif /* 0 */

        return 0;
}

Here is the call graph for this function:

static unsigned int i_get_num_dof ( const LoadableElem *  pEl )

static

Definition at line 69 of file module-template.cc.

References DEBUGCOUTFNAME.

{
        DEBUGCOUTFNAME("i_get_num_dof");
        return 0;
}

static unsigned int i_get_num_priv_data ( const LoadableElem *  pEl )

static

Definition at line 312 of file module-template.cc.

References DEBUGCOUTFNAME.

{
        DEBUGCOUTFNAME("i_get_num_priv_data");
        return 0;
}

static unsigned int i_get_priv_data_idx ( const LoadableElem *  pEl, const char *  s  )

static

Definition at line 319 of file module-template.cc.

References DEBUGCOUTFNAME, WithLabel::GetLabel(), and MBDYN_EXCEPT_ARGS.

{
        DEBUGCOUTFNAME("i_get_priv_data_idx");
        silent_cerr("Module-template Elem(" << pEl->GetLabel() << "): "
                "priv data \"" << s << "\" is unknown" << std::endl);
        throw ErrGeneric(MBDYN_EXCEPT_ARGS);

        return 0;
}

Here is the call graph for this function:

static VariableSubMatrixHandler& initial_ass_jac ( LoadableElem *  pEl, VariableSubMatrixHandler &  WorkMat, const VectorHandler &  XCurr  )

static

Definition at line 247 of file module-template.cc.

References DEBUGCOUTFNAME, LoadableElem::InitialWorkSpaceDim(), LoadableElem::pGetData(), FullSubMatrixHandler::ResizeReset(), and VariableSubMatrixHandler::SetFull().

{
        DEBUGCOUTFNAME("initial_ass_jac");
        integer iNumRows = 0;
        integer iNumCols = 0;
        pEl->InitialWorkSpaceDim(&iNumRows, &iNumCols);
        
        FullSubMatrixHandler& WM = WorkMat.SetFull();
                WM.ResizeReset(iNumRows, iNumCols);
        
#if 0
        module_template* p = (module_template *)pEl->pGetData();
#endif /* 0 */
        
        /*
         * set sub-matrix indices and coefs
         */
        
        return WorkMat;
}

Here is the call graph for this function:

static SubVectorHandler& initial_ass_res ( LoadableElem *  pEl, SubVectorHandler &  WorkVec, const VectorHandler &  XCurr  )

static

Definition at line 273 of file module-template.cc.

References DEBUGCOUTFNAME, LoadableElem::pGetData(), VectorHandler::Resize(), and LoadableElem::WorkSpaceDim().

{
        DEBUGCOUTFNAME("initial_ass_res");
        integer iNumRows = 0;
        integer iNumCols = 0;
        pEl->WorkSpaceDim(&iNumRows, &iNumCols);
        
        WorkVec.Resize(iNumRows);
        
#if 0
        module_template* p = (module_template *)pEl->pGetData(); 
#endif /* 0 */
        
        /*
         * set sub-vector indices and coefs
         */
        
        return WorkVec;
}

Here is the call graph for this function:

static void initial_work_space_dim ( const LoadableElem *  pEl, integer *  piNumRows, integer *  piNumCols  )

static

Definition at line 235 of file module-template.cc.

References DEBUGCOUTFNAME.

{
        DEBUGCOUTFNAME("initial_work_space_dim");
        *piNumRows = 0;
        *piNumCols = 0;   
}

static void output ( const LoadableElem *  pEl, OutputHandler &  OH  )

static

Definition at line 83 of file module-template.cc.

References DEBUGCOUTFNAME.

Referenced by fmu2::GetDirectionalDerivatives(), and ReadStructMappingExtForce().

{
        DEBUGCOUTFNAME("output");
}

static void* read ( LoadableElem *  pEl, DataManager *  pDM, MBDynParser &  HP  )

static

Definition at line 48 of file module-template.cc.

References DEBUGCOUTFNAME, HighParser::IsKeyWord(), and SAFENEW.

Referenced by JoystickDrive::get_one(), JoystickDrive::init(), and main().

{
        DEBUGCOUTFNAME("read");
        
        /*
         * allocation of user-defined struct
         */
        module_template* p = NULL;
        SAFENEW(p, module_template);
        
        /*
         * read data
         */
        if (HP.IsKeyWord("help")) {
                silent_cout("Module template" << std::endl);
        }
        
        return (void *)p;
}

Here is the call graph for this function:

static std::ostream& restart ( const LoadableElem *  pEl, std::ostream &  out  )

static

Definition at line 89 of file module-template.cc.

References DEBUGCOUTFNAME.

{
        DEBUGCOUTFNAME("restart");
        return out << "not implemented yet;" << std::endl;
}

static DofOrder::Order set_dof ( const LoadableElem *  , unsigned int  i  )

static

Definition at line 76 of file module-template.cc.

References DEBUGCOUTFNAME, and DofOrder::UNKNOWN.

{
        DEBUGCOUTFNAME("set_dof");
        return DofOrder::UNKNOWN;
}

static void set_initial_value ( const LoadableElem *  pEl, VectorHandler &  X  )

static

Definition at line 306 of file module-template.cc.

References DEBUGCOUTFNAME.

{
        DEBUGCOUTFNAME("set_initial_value");
}

static void set_value ( const LoadableElem *  pEl, DataManager *  pDM, VectorHandler &  X, VectorHandler &  XP, SimulationEntity::Hints *  ph  )

static

Definition at line 298 of file module-template.cc.

References DEBUGCOUTFNAME.

{
        DEBUGCOUTFNAME("set_value");
}

static void update ( LoadableElem *  pEl, const VectorHandler &  X, const VectorHandler &  XP  )

static

Definition at line 210 of file module-template.cc.

References DEBUGCOUTFNAME.

{
        DEBUGCOUTFNAME("update");
}

static void work_space_dim ( const LoadableElem *  pEl, integer *  piNumRows, integer *  piNumCols  )

static

Definition at line 96 of file module-template.cc.

References DEBUGCOUTFNAME.

{
        DEBUGCOUTFNAME("work_space_dim");
        *piNumRows = 0;
        *piNumCols = 0;
}

Variable Documentation

void* calls = &lc

Definition at line 425 of file module-template.cc.

Referenced by DataManager::SetLoadableElemModule().

struct LoadableCalls lc

static

Definition at line 389 of file module-template.cc.