blue_sky::jacobian< strategy_t > Class Template Reference

Incapsulates solving of jacobian matrix. More...

#include <jacobian.h>

List of all members.

Classes
class	jacob_traits
	For sorting jacobian children. More...
Public Types
typedef strategy_t::matrix_t	matrix_t
	short name to matrix type
typedef strategy_t::item_array_t	item_array_t
	short name to array type
typedef strategy_t::rhs_item_array_t	rhs_item_array_t
typedef strategy_t::item_t	item_t
	short name to array item type
typedef strategy_t::index_t	index_t
	short name to matrix's index type
typedef strategy_t::index_array_t	index_array_t
typedef strategy_t::barrier_t	barrier_t
typedef rs_mesh_iface< strategy_t >	mesh_iface_t
typedef strategy_t::csr_matrix_t	bcsr_matrix_t
typedef linear_solver_base < strategy_t >	linear_solver_base_t
typedef smart_ptr< matrix_t >	sp_matrix_t
typedef smart_ptr < bcsr_matrix_t, true >	sp_bcsr_matrix_t
typedef smart_ptr < jacobian_matrix< strategy_t > , true >	sp_jmatrix
	matrix type
typedef smart_ptr < linear_solver_base < strategy_t >, true >	sp_lsolver
	solver & preconditioner type
typedef smart_ptr< fi_params, true >	sp_fi_params
typedef smart_ptr < mesh_iface_t, true >	sp_mesh_iface_t
typedef jacobian< strategy_t >	this_t
Public Member Functions
void	set_solver (const sp_lsolver &s)
	set solver
void	set_prec (const sp_lsolver &p)
	set preconditioner
void	set_jmatrix (const sp_jmatrix &mx)
	set jacobian matrix
const sp_jmatrix &	get_jmatrix () const
	get jacobian matrix
const sp_lsolver &	get_solver () const
	get solver
const sp_lsolver &	get_prec () const
	get preconditioner
int	setup_solver_params (well_model_type model_type, int n_phases, const sp_fi_params &ts_params)
	set up params for solver
int	setup ()
	run solver setup
void	begin ()
void	end ()
item_t	solve (index_t &n_lin_iters)
	solve
virtual	~jacobian ()
	dtor
	BLUE_SKY_TYPE_DECL_T (jacobian)
	blue-sky type description
Protected Attributes
sp_jmatrix	jm
	jacobian matrix
sp_lsolver	solver
	solver
sp_lsolver	preconditioner
	preconditioner
auto_value< int >	solver_is_gmres_flag
	if != 0 solver point to the GMRES solver
auto_value< int >	prec_is_cpr_flag
	if != 0 if using CPR precondition
Private Member Functions
void	setup_solver (const sp_fi_params &ts_params)
	Setups solver params.
void	setup_preconditioner (const sp_fi_params &ts_params)

---

Detailed Description

template<class strategy_t>
class blue_sky::jacobian< strategy_t >

Incapsulates solving of jacobian matrix.

---

Member Typedef Documentation

template<class strategy_t >

typedef strategy_t::barrier_t blue_sky::jacobian< strategy_t >::barrier_t

template<class strategy_t >

typedef strategy_t::csr_matrix_t blue_sky::jacobian< strategy_t >::bcsr_matrix_t

template<class strategy_t >

typedef strategy_t::index_array_t blue_sky::jacobian< strategy_t >::index_array_t

template<class strategy_t >

typedef strategy_t::index_t blue_sky::jacobian< strategy_t >::index_t

short name to matrix's index type

template<class strategy_t >

typedef strategy_t::item_array_t blue_sky::jacobian< strategy_t >::item_array_t

short name to array type

template<class strategy_t >

typedef strategy_t::item_t blue_sky::jacobian< strategy_t >::item_t

short name to array item type

template<class strategy_t >

typedef linear_solver_base<strategy_t> blue_sky::jacobian< strategy_t >::linear_solver_base_t

template<class strategy_t >

typedef strategy_t::matrix_t blue_sky::jacobian< strategy_t >::matrix_t

short name to matrix type

template<class strategy_t >

typedef rs_mesh_iface< strategy_t > blue_sky::jacobian< strategy_t >::mesh_iface_t

template<class strategy_t >

typedef strategy_t::rhs_item_array_t blue_sky::jacobian< strategy_t >::rhs_item_array_t

template<class strategy_t >

typedef smart_ptr<bcsr_matrix_t, true> blue_sky::jacobian< strategy_t >::sp_bcsr_matrix_t

template<class strategy_t >

typedef smart_ptr<fi_params, true> blue_sky::jacobian< strategy_t >::sp_fi_params

template<class strategy_t >

typedef smart_ptr<jacobian_matrix<strategy_t>, true> blue_sky::jacobian< strategy_t >::sp_jmatrix

matrix type

template<class strategy_t >

typedef smart_ptr<linear_solver_base<strategy_t>, true> blue_sky::jacobian< strategy_t >::sp_lsolver

solver & preconditioner type

template<class strategy_t >

typedef smart_ptr<matrix_t> blue_sky::jacobian< strategy_t >::sp_matrix_t

template<class strategy_t >

typedef smart_ptr<mesh_iface_t, true> blue_sky::jacobian< strategy_t >::sp_mesh_iface_t

template<class strategy_t >

typedef jacobian<strategy_t> blue_sky::jacobian< strategy_t >::this_t

---

Constructor & Destructor Documentation

template<class strategy_t >

virtual blue_sky::jacobian< strategy_t >::~jacobian

(

)

[inline, virtual]

dtor

---

Member Function Documentation

template<class strategy_t >

void blue_sky::jacobian< strategy_t >::begin

(

)

Todo:

Obsolete

template<class strategy_t >

blue_sky::jacobian< strategy_t >::BLUE_SKY_TYPE_DECL_T

(

jacobian< strategy_t >

)

blue-sky type description

template<class strategy_t >

void blue_sky::jacobian< strategy_t >::end

(

)

Todo:

Obsolete

template<class strategy_t >

const sp_jmatrix& blue_sky::jacobian< strategy_t >::get_jmatrix

(

)

const [inline]

get jacobian matrix

template<class strategy_t >

const sp_lsolver& blue_sky::jacobian< strategy_t >::get_prec

(

)

const

get preconditioner

template<class strategy_t >

const sp_lsolver& blue_sky::jacobian< strategy_t >::get_solver

(

)

const

get solver

template<class strategy_t >

void blue_sky::jacobian< strategy_t >::set_jmatrix

(

const sp_jmatrix &

mx

)

[inline]

set jacobian matrix

template<class strategy_t >

void blue_sky::jacobian< strategy_t >::set_prec

(

const sp_lsolver &

p

)

[inline]

set preconditioner

template<class strategy_t >

void blue_sky::jacobian< strategy_t >::set_solver

(

const sp_lsolver &

s

)

[inline]

set solver

template<class strategy_t >

int blue_sky::jacobian< strategy_t >::setup

(

)

run solver setup

template<class strategy_t >

void blue_sky::jacobian< strategy_t >::setup_preconditioner

(

const sp_fi_params &

ts_params

)

[private]

Todo:

Obsolete

template<class strategy_t >

void blue_sky::jacobian< strategy_t >::setup_solver

(

const sp_fi_params &

ts_params

)

[private]

Setups solver params.

Parameters:

ts_params

Params holder

template<class strategy_t >

int blue_sky::jacobian< strategy_t >::setup_solver_params	(	well_model_type	model_type,
		int	n_phases,
		const sp_fi_params &	ts_params
	)

set up params for solver

template<class strategy_t >

item_t blue_sky::jacobian< strategy_t >::solve

(

index_t &

n_lin_iters

)

solve

---

Member Data Documentation

template<class strategy_t >

sp_jmatrix blue_sky::jacobian< strategy_t >::jm [protected]

jacobian matrix

template<class strategy_t >

auto_value<int> blue_sky::jacobian< strategy_t >::prec_is_cpr_flag [protected]

if != 0 if using CPR precondition

template<class strategy_t >

sp_lsolver blue_sky::jacobian< strategy_t >::preconditioner [protected]

preconditioner

template<class strategy_t >

sp_lsolver blue_sky::jacobian< strategy_t >::solver [protected]

solver

template<class strategy_t >

auto_value<int> blue_sky::jacobian< strategy_t >::solver_is_gmres_flag [protected]

if != 0 solver point to the GMRES solver

---

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

• jacobian.h