Logo ROOT  
Reference Guide
TQpLinSolverBase Class Referenceabstract

Implementation of main solver for linear systems

Definition at line 66 of file TQpLinSolverBase.h.

Public Member Functions

 TQpLinSolverBase ()
 Default constructor. More...
 
 TQpLinSolverBase (const TQpLinSolverBase &another)
 Copy constructor. More...
 
 TQpLinSolverBase (TQpProbBase *factory, TQpDataBase *data)
 Constructor. More...
 
virtual ~TQpLinSolverBase ()
 
virtual void ComputeDiagonals (TVectorD &dd, TVectorD &omega, TVectorD &t, TVectorD &lambda, TVectorD &u, TVectorD &pi, TVectorD &v, TVectorD &gamma, TVectorD &w, TVectorD &phi)
 Computes the diagonal matrices in the augmented system from the current set of variables. More...
 
virtual void Factor (TQpDataBase *prob, TQpVar *vars)
 Sets up the matrix for the main linear system in "augmented system" form. More...
 
virtual void JoinRHS (TVectorD &rhs, TVectorD &rhs1, TVectorD &rhs2, TVectorD &rhs3)
 Assembles a single vector object from three given vectors . More...
 
TQpLinSolverBaseoperator= (const TQpLinSolverBase &source)
 Assignment opeartor. More...
 
virtual void PutXDiagonal (TVectorD &xdiag)=0
 
virtual void PutZDiagonal (TVectorD &zdiag)=0
 
virtual void SeparateVars (TVectorD &vars1, TVectorD &vars2, TVectorD &vars3, TVectorD &vars)
 Extracts three component vectors from a given aggregated vector. More...
 
virtual void Solve (TQpDataBase *prob, TQpVar *vars, TQpResidual *resids, TQpVar *step)
 Solves the system for a given set of residuals. More...
 
virtual void SolveCompressed (TVectorD &rhs)=0
 
virtual void SolveXYZS (TVectorD &stepx, TVectorD &stepy, TVectorD &stepz, TVectorD &steps, TVectorD &ztemp, TQpDataBase *data)
 Assemble right-hand side of augmented system and call SolveCompressed to solve it. More...
 
- Public Member Functions inherited from TObject
 TObject ()
 TObject constructor. More...
 
 TObject (const TObject &object)
 TObject copy ctor. More...
 
virtual ~TObject ()
 TObject destructor. More...
 
void AbstractMethod (const char *method) const
 Use this method to implement an "abstract" method that you don't want to leave purely abstract. More...
 
virtual void AppendPad (Option_t *option="")
 Append graphics object to current pad. More...
 
virtual void Browse (TBrowser *b)
 Browse object. May be overridden for another default action. More...
 
ULong_t CheckedHash ()
 Check and record whether this class has a consistent Hash/RecursiveRemove setup (*) and then return the regular Hash value for this object. More...
 
virtual const char * ClassName () const
 Returns name of class to which the object belongs. More...
 
virtual void Clear (Option_t *="")
 
virtual TObjectClone (const char *newname="") const
 Make a clone of an object using the Streamer facility. More...
 
virtual Int_t Compare (const TObject *obj) const
 Compare abstract method. More...
 
virtual void Copy (TObject &object) const
 Copy this to obj. More...
 
virtual void Delete (Option_t *option="")
 Delete this object. More...
 
virtual Int_t DistancetoPrimitive (Int_t px, Int_t py)
 Computes distance from point (px,py) to the object. More...
 
virtual void Draw (Option_t *option="")
 Default Draw method for all objects. More...
 
virtual void DrawClass () const
 Draw class inheritance tree of the class to which this object belongs. More...
 
virtual TObjectDrawClone (Option_t *option="") const
 Draw a clone of this object in the current selected pad for instance with: gROOT->SetSelectedPad(gPad). More...
 
virtual void Dump () const
 Dump contents of object on stdout. More...
 
virtual void Error (const char *method, const char *msgfmt,...) const
 Issue error message. More...
 
virtual void Execute (const char *method, const char *params, Int_t *error=0)
 Execute method on this object with the given parameter string, e.g. More...
 
virtual void Execute (TMethod *method, TObjArray *params, Int_t *error=0)
 Execute method on this object with parameters stored in the TObjArray. More...
 
virtual void ExecuteEvent (Int_t event, Int_t px, Int_t py)
 Execute action corresponding to an event at (px,py). More...
 
virtual void Fatal (const char *method, const char *msgfmt,...) const
 Issue fatal error message. More...
 
virtual TObjectFindObject (const char *name) const
 Must be redefined in derived classes. More...
 
virtual TObjectFindObject (const TObject *obj) const
 Must be redefined in derived classes. More...
 
virtual Option_tGetDrawOption () const
 Get option used by the graphics system to draw this object. More...
 
virtual const char * GetIconName () const
 Returns mime type name of object. More...
 
virtual const char * GetName () const
 Returns name of object. More...
 
virtual char * GetObjectInfo (Int_t px, Int_t py) const
 Returns string containing info about the object at position (px,py). More...
 
virtual Option_tGetOption () const
 
virtual const char * GetTitle () const
 Returns title of object. More...
 
virtual UInt_t GetUniqueID () const
 Return the unique object id. More...
 
virtual Bool_t HandleTimer (TTimer *timer)
 Execute action in response of a timer timing out. More...
 
virtual ULong_t Hash () const
 Return hash value for this object. More...
 
Bool_t HasInconsistentHash () const
 Return true is the type of this object is known to have an inconsistent setup for Hash and RecursiveRemove (i.e. More...
 
virtual void Info (const char *method, const char *msgfmt,...) const
 Issue info message. More...
 
virtual Bool_t InheritsFrom (const char *classname) const
 Returns kTRUE if object inherits from class "classname". More...
 
virtual Bool_t InheritsFrom (const TClass *cl) const
 Returns kTRUE if object inherits from TClass cl. More...
 
virtual void Inspect () const
 Dump contents of this object in a graphics canvas. More...
 
void InvertBit (UInt_t f)
 
virtual Bool_t IsEqual (const TObject *obj) const
 Default equal comparison (objects are equal if they have the same address in memory). More...
 
virtual Bool_t IsFolder () const
 Returns kTRUE in case object contains browsable objects (like containers or lists of other objects). More...
 
R__ALWAYS_INLINE Bool_t IsOnHeap () const
 
virtual Bool_t IsSortable () const
 
R__ALWAYS_INLINE Bool_t IsZombie () const
 
virtual void ls (Option_t *option="") const
 The ls function lists the contents of a class on stdout. More...
 
void MayNotUse (const char *method) const
 Use this method to signal that a method (defined in a base class) may not be called in a derived class (in principle against good design since a child class should not provide less functionality than its parent, however, sometimes it is necessary). More...
 
virtual Bool_t Notify ()
 This method must be overridden to handle object notification. More...
 
void Obsolete (const char *method, const char *asOfVers, const char *removedFromVers) const
 Use this method to declare a method obsolete. More...
 
void operator delete (void *ptr)
 Operator delete. More...
 
void operator delete[] (void *ptr)
 Operator delete []. More...
 
voidoperator new (size_t sz)
 
voidoperator new (size_t sz, void *vp)
 
voidoperator new[] (size_t sz)
 
voidoperator new[] (size_t sz, void *vp)
 
TObjectoperator= (const TObject &rhs)
 TObject assignment operator. More...
 
virtual void Paint (Option_t *option="")
 This method must be overridden if a class wants to paint itself. More...
 
virtual void Pop ()
 Pop on object drawn in a pad to the top of the display list. More...
 
virtual void Print (Option_t *option="") const
 This method must be overridden when a class wants to print itself. More...
 
virtual Int_t Read (const char *name)
 Read contents of object with specified name from the current directory. More...
 
virtual void RecursiveRemove (TObject *obj)
 Recursively remove this object from a list. More...
 
void ResetBit (UInt_t f)
 
virtual void SaveAs (const char *filename="", Option_t *option="") const
 Save this object in the file specified by filename. More...
 
virtual void SavePrimitive (std::ostream &out, Option_t *option="")
 Save a primitive as a C++ statement(s) on output stream "out". More...
 
void SetBit (UInt_t f)
 
void SetBit (UInt_t f, Bool_t set)
 Set or unset the user status bits as specified in f. More...
 
virtual void SetDrawOption (Option_t *option="")
 Set drawing option for object. More...
 
virtual void SetUniqueID (UInt_t uid)
 Set the unique object id. More...
 
virtual void SysError (const char *method, const char *msgfmt,...) const
 Issue system error message. More...
 
R__ALWAYS_INLINE Bool_t TestBit (UInt_t f) const
 
Int_t TestBits (UInt_t f) const
 
virtual void UseCurrentStyle ()
 Set current style settings in this object This function is called when either TCanvas::UseCurrentStyle or TROOT::ForceStyle have been invoked. More...
 
virtual void Warning (const char *method, const char *msgfmt,...) const
 Issue warning message. More...
 
virtual Int_t Write (const char *name=0, Int_t option=0, Int_t bufsize=0)
 Write this object to the current directory. More...
 
virtual Int_t Write (const char *name=0, Int_t option=0, Int_t bufsize=0) const
 Write this object to the current directory. More...
 

Protected Attributes

TVectorD fCloIndex
 
TVectorD fCupIndex
 
TVectorD fDd
 
TVectorD fDq
 
TQpProbBasefFactory
 
Int_t fMclo
 
Int_t fMcup
 
Int_t fMy
 
Int_t fMz
 
TVectorD fNomegaInv
 
Int_t fNx
 
Int_t fNxlo
 
Int_t fNxup
 
TVectorD fRhs
 
TVectorD fXloIndex
 
TVectorD fXupIndex
 

Additional Inherited Members

- Public Types inherited from TObject
enum  {
  kIsOnHeap = 0x01000000, kNotDeleted = 0x02000000, kZombie = 0x04000000, kInconsistent = 0x08000000,
  kBitMask = 0x00ffffff
}
 
enum  { kSingleKey = BIT(0), kOverwrite = BIT(1), kWriteDelete = BIT(2) }
 
enum  EDeprecatedStatusBits { kObjInCanvas = BIT(3) }
 
enum  EStatusBits {
  kCanDelete = BIT(0), kMustCleanup = BIT(3), kIsReferenced = BIT(4), kHasUUID = BIT(5),
  kCannotPick = BIT(6), kNoContextMenu = BIT(8), kInvalidObject = BIT(13)
}
 
- Static Public Member Functions inherited from TObject
static Long_t GetDtorOnly ()
 Return destructor only flag. More...
 
static Bool_t GetObjectStat ()
 Get status of object stat flag. More...
 
static void SetDtorOnly (void *obj)
 Set destructor only flag. More...
 
static void SetObjectStat (Bool_t stat)
 Turn on/off tracking of objects in the TObjectTable. More...
 
- Protected Member Functions inherited from TObject
virtual void DoError (int level, const char *location, const char *fmt, va_list va) const
 Interface to ErrorHandler (protected). More...
 
void MakeZombie ()
 

#include <TQpLinSolverBase.h>

Inheritance diagram for TQpLinSolverBase:
[legend]

Constructor & Destructor Documentation

◆ TQpLinSolverBase() [1/3]

TQpLinSolverBase::TQpLinSolverBase ( )

Default constructor.

Definition at line 58 of file TQpLinSolverBase.cxx.

◆ TQpLinSolverBase() [2/3]

TQpLinSolverBase::TQpLinSolverBase ( TQpProbBase factory,
TQpDataBase data 
)

Constructor.

Definition at line 74 of file TQpLinSolverBase.cxx.

◆ TQpLinSolverBase() [3/3]

TQpLinSolverBase::TQpLinSolverBase ( const TQpLinSolverBase another)

Copy constructor.

Definition at line 105 of file TQpLinSolverBase.cxx.

◆ ~TQpLinSolverBase()

virtual TQpLinSolverBase::~TQpLinSolverBase ( )
inlinevirtual

Definition at line 98 of file TQpLinSolverBase.h.

Member Function Documentation

◆ ComputeDiagonals()

void TQpLinSolverBase::ComputeDiagonals ( TVectorD dd,
TVectorD omega,
TVectorD t,
TVectorD lambda,
TVectorD u,
TVectorD pi,
TVectorD v,
TVectorD gamma,
TVectorD w,
TVectorD phi 
)
virtual

Computes the diagonal matrices in the augmented system from the current set of variables.

Definition at line 140 of file TQpLinSolverBase.cxx.

◆ Factor()

void TQpLinSolverBase::Factor ( TQpDataBase prob,
TQpVar vars 
)
virtual

Sets up the matrix for the main linear system in "augmented system" form.

The actual factorization is performed by a routine specific to either the sparse or dense case

Reimplemented in TQpLinSolverDens, and TQpLinSolverSparse.

Definition at line 117 of file TQpLinSolverBase.cxx.

◆ JoinRHS()

void TQpLinSolverBase::JoinRHS ( TVectorD rhs_out,
TVectorD rhs1_in,
TVectorD rhs2_in,
TVectorD rhs3_in 
)
virtual

Assembles a single vector object from three given vectors .

rhs_out (output) final joined vector rhs1_in (input) first part of rhs rhs2_in (input) middle part of rhs rhs3_in (input) last part of rhs .

Definition at line 288 of file TQpLinSolverBase.cxx.

◆ operator=()

TQpLinSolverBase & TQpLinSolverBase::operator= ( const TQpLinSolverBase source)

Assignment opeartor.

Definition at line 312 of file TQpLinSolverBase.cxx.

◆ PutXDiagonal()

virtual void TQpLinSolverBase::PutXDiagonal ( TVectorD xdiag)
pure virtual

Implemented in TQpLinSolverDens, and TQpLinSolverSparse.

◆ PutZDiagonal()

virtual void TQpLinSolverBase::PutZDiagonal ( TVectorD zdiag)
pure virtual

Implemented in TQpLinSolverDens, and TQpLinSolverSparse.

◆ SeparateVars()

void TQpLinSolverBase::SeparateVars ( TVectorD x_in,
TVectorD y_in,
TVectorD z_in,
TVectorD vars_in 
)
virtual

Extracts three component vectors from a given aggregated vector.

vars_in (input) aggregated vector x_in (output) first part of vars y_in (output) middle part of vars z_in (output) last part of vars

Definition at line 302 of file TQpLinSolverBase.cxx.

◆ Solve()

void TQpLinSolverBase::Solve ( TQpDataBase prob,
TQpVar vars,
TQpResidual res,
TQpVar step 
)
virtual

Solves the system for a given set of residuals.

Assembles the right-hand side appropriate to the matrix factored in factor, solves the system using the factorization produced there, partitions the solution vector into step components, then recovers the step components eliminated during the block elimination that produced the augmented system form .

Definition at line 162 of file TQpLinSolverBase.cxx.

◆ SolveCompressed()

virtual void TQpLinSolverBase::SolveCompressed ( TVectorD rhs)
pure virtual

Implemented in TQpLinSolverDens, and TQpLinSolverSparse.

◆ SolveXYZS()

void TQpLinSolverBase::SolveXYZS ( TVectorD stepx,
TVectorD stepy,
TVectorD stepz,
TVectorD steps,
TVectorD ztemp,
TQpDataBase data 
)
virtual

Assemble right-hand side of augmented system and call SolveCompressed to solve it.

Definition at line 261 of file TQpLinSolverBase.cxx.

Member Data Documentation

◆ fCloIndex

TVectorD TQpLinSolverBase::fCloIndex
protected

Definition at line 84 of file TQpLinSolverBase.h.

◆ fCupIndex

TVectorD TQpLinSolverBase::fCupIndex
protected

Definition at line 82 of file TQpLinSolverBase.h.

◆ fDd

TVectorD TQpLinSolverBase::fDd
protected

Definition at line 78 of file TQpLinSolverBase.h.

◆ fDq

TVectorD TQpLinSolverBase::fDq
protected

Definition at line 79 of file TQpLinSolverBase.h.

◆ fFactory

TQpProbBase* TQpLinSolverBase::fFactory
protected

Definition at line 91 of file TQpLinSolverBase.h.

◆ fMclo

Int_t TQpLinSolverBase::fMclo
protected

Definition at line 89 of file TQpLinSolverBase.h.

◆ fMcup

Int_t TQpLinSolverBase::fMcup
protected

Definition at line 88 of file TQpLinSolverBase.h.

◆ fMy

Int_t TQpLinSolverBase::fMy
protected

Definition at line 75 of file TQpLinSolverBase.h.

◆ fMz

Int_t TQpLinSolverBase::fMz
protected

Definition at line 76 of file TQpLinSolverBase.h.

◆ fNomegaInv

TVectorD TQpLinSolverBase::fNomegaInv
protected

Definition at line 71 of file TQpLinSolverBase.h.

◆ fNx

Int_t TQpLinSolverBase::fNx
protected

Definition at line 74 of file TQpLinSolverBase.h.

◆ fNxlo

Int_t TQpLinSolverBase::fNxlo
protected

Definition at line 87 of file TQpLinSolverBase.h.

◆ fNxup

Int_t TQpLinSolverBase::fNxup
protected

Definition at line 86 of file TQpLinSolverBase.h.

◆ fRhs

TVectorD TQpLinSolverBase::fRhs
protected

Definition at line 72 of file TQpLinSolverBase.h.

◆ fXloIndex

TVectorD TQpLinSolverBase::fXloIndex
protected

Definition at line 83 of file TQpLinSolverBase.h.

◆ fXupIndex

TVectorD TQpLinSolverBase::fXupIndex
protected

Definition at line 81 of file TQpLinSolverBase.h.

Libraries for TQpLinSolverBase:
[legend]

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