Implementation of main solver for linear systems.

Definition at line 66 of file TQpLinSolverBase.h.

Public Member Functions
	TQpLinSolverBase ()
	Default constructor.

	TQpLinSolverBase (const TQpLinSolverBase &another)
	Copy constructor.

	TQpLinSolverBase (TQpProbBase factory, TQpDataBase data)
	Constructor.

	~TQpLinSolverBase () override

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.

virtual void	Factor (TQpDataBase prob, TQpVar vars)
	Sets up the matrix for the main linear system in "augmented system" form.

virtual void	JoinRHS (TVectorD &rhs, TVectorD &rhs1, TVectorD &rhs2, TVectorD &rhs3)
	Assembles a single vector object from three given vectors .

TQpLinSolverBase &	operator= (const TQpLinSolverBase &source)
	Assignment operator.

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.

virtual void	Solve (TQpDataBase prob, TQpVar vars, TQpResidual resids, TQpVar step)
	Solves the system for a given set of residuals.

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.

Public Member Functions inherited from TObject
	TObject ()
	TObject constructor.

	TObject (const TObject &object)
	TObject copy ctor.

virtual	~TObject ()
	TObject destructor.

void	AbstractMethod (const char *method) const
	Use this method to implement an "abstract" method that you don't want to leave purely abstract.

virtual void	AppendPad (Option_t *option="")
	Append graphics object to current pad.

virtual void	Browse (TBrowser *b)
	Browse object. May be overridden for another default action.

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.

virtual const char *	ClassName () const
	Returns name of class to which the object belongs.

virtual void	Clear (Option_t *="")

virtual TObject *	Clone (const char *newname="") const
	Make a clone of an object using the Streamer facility.

virtual Int_t	Compare (const TObject *obj) const
	Compare abstract method.

virtual void	Copy (TObject &object) const
	Copy this to obj.

virtual void	Delete (Option_t *option="")
	Delete this object.

virtual Int_t	DistancetoPrimitive (Int_t px, Int_t py)
	Computes distance from point (px,py) to the object.

virtual void	Draw (Option_t *option="")
	Default Draw method for all objects.

virtual void	DrawClass () const
	Draw class inheritance tree of the class to which this object belongs.

virtual TObject *	DrawClone (Option_t *option="") const
	Draw a clone of this object in the current selected pad with: `gROOT->SetSelectedPad(c1)`.

virtual void	Dump () const
	Dump contents of object on stdout.

virtual void	Error (const char method, const char msgfmt,...) const
	Issue error message.

virtual void	Execute (const char method, const char params, Int_t *error=nullptr)
	Execute method on this object with the given parameter string, e.g.

virtual void	Execute (TMethod method, TObjArray params, Int_t *error=nullptr)
	Execute method on this object with parameters stored in the TObjArray.

virtual void	ExecuteEvent (Int_t event, Int_t px, Int_t py)
	Execute action corresponding to an event at (px,py).

virtual void	Fatal (const char method, const char msgfmt,...) const
	Issue fatal error message.

virtual TObject *	FindObject (const char *name) const
	Must be redefined in derived classes.

virtual TObject *	FindObject (const TObject *obj) const
	Must be redefined in derived classes.

virtual Option_t *	GetDrawOption () const
	Get option used by the graphics system to draw this object.

virtual const char *	GetIconName () const
	Returns mime type name of object.

virtual const char *	GetName () const
	Returns name of object.

virtual char *	GetObjectInfo (Int_t px, Int_t py) const
	Returns string containing info about the object at position (px,py).

virtual Option_t *	GetOption () const

virtual const char *	GetTitle () const
	Returns title of object.

virtual UInt_t	GetUniqueID () const
	Return the unique object id.

virtual Bool_t	HandleTimer (TTimer *timer)
	Execute action in response of a timer timing out.

virtual ULong_t	Hash () const
	Return hash value for this object.

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.

virtual void	Info (const char method, const char msgfmt,...) const
	Issue info message.

virtual Bool_t	InheritsFrom (const char *classname) const
	Returns kTRUE if object inherits from class "classname".

virtual Bool_t	InheritsFrom (const TClass *cl) const
	Returns kTRUE if object inherits from TClass cl.

virtual void	Inspect () const
	Dump contents of this object in a graphics canvas.

void	InvertBit (UInt_t f)

virtual TClass *	IsA () const

Bool_t	IsDestructed () const
	IsDestructed.

virtual Bool_t	IsEqual (const TObject *obj) const
	Default equal comparison (objects are equal if they have the same address in memory).

virtual Bool_t	IsFolder () const
	Returns kTRUE in case object contains browsable objects (like containers or lists of other objects).

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.

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).

virtual Bool_t	Notify ()
	This method must be overridden to handle object notification (the base implementation is no-op).

void	Obsolete (const char method, const char asOfVers, const char *removedFromVers) const
	Use this method to declare a method obsolete.

void	operator delete (void *ptr)
	Operator delete.

void	operator delete (void ptr, void vp)
	Only called by placement new when throwing an exception.

void	operator delete[] (void *ptr)
	Operator delete [].

void	operator delete[] (void ptr, void vp)
	Only called by placement new[] when throwing an exception.

void *	operator new (size_t sz)

void *	operator new (size_t sz, void *vp)

void *	operator new[] (size_t sz)

void *	operator new[] (size_t sz, void *vp)

TObject &	operator= (const TObject &rhs)
	TObject assignment operator.

virtual void	Paint (Option_t *option="")
	This method must be overridden if a class wants to paint itself.

virtual void	Pop ()
	Pop on object drawn in a pad to the top of the display list.

virtual void	Print (Option_t *option="") const
	This method must be overridden when a class wants to print itself.

virtual Int_t	Read (const char *name)
	Read contents of object with specified name from the current directory.

virtual void	RecursiveRemove (TObject *obj)
	Recursively remove this object from a list.

void	ResetBit (UInt_t f)

virtual void	SaveAs (const char filename="", Option_t option="") const
	Save this object in the file specified by filename.

virtual void	SavePrimitive (std::ostream &out, Option_t *option="")
	Save a primitive as a C++ statement(s) on output stream "out".

void	SetBit (UInt_t f)

void	SetBit (UInt_t f, Bool_t set)
	Set or unset the user status bits as specified in f.

virtual void	SetDrawOption (Option_t *option="")
	Set drawing option for object.

virtual void	SetUniqueID (UInt_t uid)
	Set the unique object id.

virtual void	Streamer (TBuffer &)
	Stream an object of class TObject.

void	StreamerNVirtual (TBuffer &ClassDef_StreamerNVirtual_b)

virtual void	SysError (const char method, const char msgfmt,...) const
	Issue system error message.

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.

virtual void	Warning (const char method, const char msgfmt,...) const
	Issue warning message.

virtual Int_t	Write (const char *name=nullptr, Int_t option=0, Int_t bufsize=0)
	Write this object to the current directory.

virtual Int_t	Write (const char *name=nullptr, Int_t option=0, Int_t bufsize=0) const
	Write this object to the current directory.

Protected Attributes
TVectorD	fCloIndex

TVectorD	fCupIndex

TVectorD	fDd

TVectorD	fDq

TQpProbBase *	fFactory

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 = (1ULL << ( 0 )) , kOverwrite = (1ULL << ( 1 )) , kWriteDelete = (1ULL << ( 2 )) }

enum	EDeprecatedStatusBits { kObjInCanvas = (1ULL << ( 3 )) }

enum	EStatusBits { kCanDelete = (1ULL << ( 0 )) , kMustCleanup = (1ULL << ( 3 )) , kIsReferenced = (1ULL << ( 4 )) , kHasUUID = (1ULL << ( 5 )) , kCannotPick = (1ULL << ( 6 )) , kNoContextMenu = (1ULL << ( 8 )) , kInvalidObject = (1ULL << ( 13 )) }

Static Public Member Functions inherited from TObject
static TClass *	Class ()

static const char *	Class_Name ()

static constexpr Version_t	Class_Version ()

static const char *	DeclFileName ()

static Longptr_t	GetDtorOnly ()
	Return destructor only flag.

static Bool_t	GetObjectStat ()
	Get status of object stat flag.

static void	SetDtorOnly (void *obj)
	Set destructor only flag.

static void	SetObjectStat (Bool_t stat)
	Turn on/off tracking of objects in the TObjectTable.

Protected Types inherited from TObject
enum	{ kOnlyPrepStep = (1ULL << ( 3 )) }

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).

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()

TQpLinSolverBase::~TQpLinSolverBase ( )

inlineoverride

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 operator.

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:

math/quadp/inc/TQpLinSolverBase.h
math/quadp/src/TQpLinSolverBase.cxx

Public Member Functions

Protected Attributes

Additional Inherited Members

Constructor & Destructor Documentation

◆ TQpLinSolverBase() [1/3]

◆ TQpLinSolverBase() [2/3]

◆ TQpLinSolverBase() [3/3]

◆ ~TQpLinSolverBase()

Member Function Documentation

◆ ComputeDiagonals()

◆ Factor()

◆ JoinRHS()

◆ operator=()

◆ PutXDiagonal()

◆ PutZDiagonal()

◆ SeparateVars()

◆ Solve()

◆ SolveCompressed()

◆ SolveXYZS()

Member Data Documentation

◆ fCloIndex

◆ fCupIndex

◆ fDd

◆ fDq

◆ fFactory

◆ fMclo

◆ fMcup

◆ fMy

◆ fMz

◆ fNomegaInv

◆ fNx

◆ fNxlo

◆ fNxup

◆ fRhs

◆ fXloIndex

◆ fXupIndex