INMOST
A toolkit for distributed mathematical modeling
INMOST::AbstractMatrixFunction Class Referenceabstract

This can be used to abstract implementation of particular matrix functions, that depend on mesh data and variables of the models. More...

#include <inmost_model.h>

Public Member Functions

virtual bool Initialize (Model &P)=0
 Initialize coupling and dependent unknowns.
 
virtual bool SetupCoupling (Model &P)
 Setup coupling with unknowns of otheer models.
 
virtual vMatrix Evaluate (const Storage &e) const =0
 The main function provided by operator. More...
 
virtual bool PrepareIterations ()
 This functions might be not necessary: More...
 
virtual bool UpdateTimeStep ()
 Update time step.
 
virtual bool SetTimeStep (double dt)
 Provide time step.
 
virtual bool SetTime (double t)
 Provide current time.
 
virtual bool RestoreTimeStep ()
 Roll back to previous step.
 
virtual double UpdateMultiplier (const Sparse::Vector &sol) const
 Calculate multiplier for update for this function. Can simply return 1.
 
virtual double AdjustTimeStep (double dt) const
 Calculate time step for this model. Can simply return dt.
 

Detailed Description

This can be used to abstract implementation of particular matrix functions, that depend on mesh data and variables of the models.

Definition at line 151 of file inmost_model.h.

Member Function Documentation

◆ Evaluate()

virtual vMatrix INMOST::AbstractMatrixFunction::Evaluate ( const Storage e) const
pure virtual

The main function provided by operator.

Parameters
eElement on which operator is evaluated.
Returns
matrix value of the coupling function.

◆ PrepareIterations()

virtual bool INMOST::AbstractMatrixFunction::PrepareIterations ( )
inlinevirtual

This functions might be not necessary:

Initialize data needed for FillResidual. Called once before nonlinear iterations.

Definition at line 169 of file inmost_model.h.


The documentation for this class was generated from the following file: