INMOST::AbstractCouplingTerm Class Reference

A class to manage residual fill-in of the coupling between 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 bool	FillResidual (Residual &R) const =0
	Fill part of the residual related to my unknowns.
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 model. Can simply return 1.
virtual double	AdjustTimeStep (double dt) const
	Calculate time step for this model. Can simply return dt.

Detailed Description

A class to manage residual fill-in of the coupling between models.

Use this to introduce coupling terms that depends on the data between the models. Coupling term does not introduce its own unknowns and writes to the residual.

Definition at line 83 of file inmost_model.h.

Member Function Documentation

PrepareIterations()

virtual bool INMOST::AbstractCouplingTerm::PrepareIterations ( )

inlinevirtual

This functions might be not necessary:

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

Definition at line 99 of file inmost_model.h.

---

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

• inmost_model.h