Xyce  6.1
Xyce::Nonlinear::N_NLS_NOX::GStepping Class Reference

#include <N_NLS_NOX_AugmentLinSys_GStepping.h>

Inheritance diagram for Xyce::Nonlinear::N_NLS_NOX::GStepping:
Collaboration diagram for Xyce::Nonlinear::N_NLS_NOX::GStepping:

Public Types

enum  NodeListType {
  NLT_VoltageNodes,
  NLT_AllVoltageUnknowns
}
 

Public Member Functions

 GStepping (const std::vector< int > &vnodeGIDVec, Xyce::Linear::Vector *cloneVector, double endValue, double residCond=0)
 Ctor for the voltage nodes as a GID list. More...
 
 GStepping (const Teuchos::RCP< Epetra_MapColoring > &color_map, Xyce::Linear::Vector *cloneVector, double endValue, double residCond=0)
 Ctor with an EpetraMapColoring for all voltage unknowns. More...
 
 ~GStepping ()
 Dtor. More...
 
void setProgressVariable (double time_step_size)
 Set the progress variable (time step size for pseudo transient). More...
 
void augmentResidual (const Xyce::Linear::Vector *solution, Xyce::Linear::Vector *residual_vector)
 Augments the Residual. More...
 
void augmentJacobian (Xyce::Linear::Matrix *jacobian)
 Augments the Jacobian. More...
 
void setResidualConductance (double c)
 
- Public Member Functions inherited from Xyce::Nonlinear::N_NLS_NOX::AugmentLinSys
 AugmentLinSys ()
 Ctor. More...
 
 ~AugmentLinSys ()
 Dtor. More...
 

Private Attributes

NodeListType node_list_type_
 Type of list we are using. More...
 
double conductance_
 Conductance. More...
 
const std::vector< int > vnodeGIDVec_
 List of voltage node GIDs. More...
 
Teuchos::RCP< Epetra_MapColoring > color_map_
 Color 0 are the voltage unknowns. More...
 
Xyce::Linear::Vector * tmp_vector_ptr_
 Temporary vector used to store diagonal. More...
 
double scaled_end_value_
 low end of the exponential term. More...
 
double residualConductance_
 residual value of the conductance. Should almost always be zero More...
 

Detailed Description

Definition at line 67 of file N_NLS_NOX_AugmentLinSys_GStepping.h.

Member Enumeration Documentation

Enumerator
NLT_VoltageNodes 
NLT_AllVoltageUnknowns 

Definition at line 71 of file N_NLS_NOX_AugmentLinSys_GStepping.h.

Constructor & Destructor Documentation

Xyce::Nonlinear::N_NLS_NOX::GStepping::GStepping ( const std::vector< int > &  vnodeGIDVec,
Xyce::Linear::Vector *  cloneVector,
double  endValue,
double  residCond = 0 
)

Ctor for the voltage nodes as a GID list.

Xyce::Nonlinear::N_NLS_NOX::GStepping::GStepping ( const Teuchos::RCP< Epetra_MapColoring > &  color_map,
Xyce::Linear::Vector *  cloneVector,
double  endValue,
double  residCond = 0 
)

Ctor with an EpetraMapColoring for all voltage unknowns.

Xyce::Nonlinear::N_NLS_NOX::GStepping::~GStepping ( )

Dtor.

Definition at line 114 of file N_NLS_NOX_AugmentLinSys_GStepping.C.

Member Function Documentation

void Xyce::Nonlinear::N_NLS_NOX::GStepping::augmentJacobian ( Xyce::Linear::Matrix *  jacobian)
virtual

Augments the Jacobian.

Implements Xyce::Nonlinear::N_NLS_NOX::AugmentLinSys.

Definition at line 178 of file N_NLS_NOX_AugmentLinSys_GStepping.C.

void Xyce::Nonlinear::N_NLS_NOX::GStepping::augmentResidual ( const Xyce::Linear::Vector *  solution,
Xyce::Linear::Vector *  residual_vector 
)
virtual

Augments the Residual.

Implements Xyce::Nonlinear::N_NLS_NOX::AugmentLinSys.

Definition at line 142 of file N_NLS_NOX_AugmentLinSys_GStepping.C.

void Xyce::Nonlinear::N_NLS_NOX::GStepping::setProgressVariable ( double  value)
virtual

Set the progress variable (time step size for pseudo transient).

Implements Xyce::Nonlinear::N_NLS_NOX::AugmentLinSys.

Definition at line 128 of file N_NLS_NOX_AugmentLinSys_GStepping.C.

void Xyce::Nonlinear::N_NLS_NOX::GStepping::setResidualConductance ( double  c)
inline

Definition at line 101 of file N_NLS_NOX_AugmentLinSys_GStepping.h.

Member Data Documentation

Teuchos::RCP<Epetra_MapColoring> Xyce::Nonlinear::N_NLS_NOX::GStepping::color_map_
private

Color 0 are the voltage unknowns.

Definition at line 115 of file N_NLS_NOX_AugmentLinSys_GStepping.h.

double Xyce::Nonlinear::N_NLS_NOX::GStepping::conductance_
private

Conductance.

Definition at line 109 of file N_NLS_NOX_AugmentLinSys_GStepping.h.

NodeListType Xyce::Nonlinear::N_NLS_NOX::GStepping::node_list_type_
private

Type of list we are using.

Definition at line 101 of file N_NLS_NOX_AugmentLinSys_GStepping.h.

double Xyce::Nonlinear::N_NLS_NOX::GStepping::residualConductance_
private

residual value of the conductance. Should almost always be zero

Definition at line 124 of file N_NLS_NOX_AugmentLinSys_GStepping.h.

double Xyce::Nonlinear::N_NLS_NOX::GStepping::scaled_end_value_
private

low end of the exponential term.

Definition at line 121 of file N_NLS_NOX_AugmentLinSys_GStepping.h.

Xyce::Linear::Vector* Xyce::Nonlinear::N_NLS_NOX::GStepping::tmp_vector_ptr_
private

Temporary vector used to store diagonal.

Definition at line 118 of file N_NLS_NOX_AugmentLinSys_GStepping.h.

const std::vector<int> Xyce::Nonlinear::N_NLS_NOX::GStepping::vnodeGIDVec_
private

List of voltage node GIDs.

Definition at line 112 of file N_NLS_NOX_AugmentLinSys_GStepping.h.


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