Xyce  6.1
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
N_NLS_NOX_AugmentLinSys_GStepping.h
Go to the documentation of this file.
1 //-----------------------------------------------------------------------------
2 // Copyright Notice
3 //
4 // Copyright 2002 Sandia Corporation. Under the terms
5 // of Contract DE-AC04-94AL85000 with Sandia Corporation, the U.S.
6 // Government retains certain rights in this software.
7 //
8 // Xyce(TM) Parallel Electrical Simulator
9 // Copyright (C) 2002-2014 Sandia Corporation
10 //
11 // This program is free software: you can redistribute it and/or modify
12 // it under the terms of the GNU General Public License as published by
13 // the Free Software Foundation, either version 3 of the License, or
14 // (at your option) any later version.
15 //
16 // This program is distributed in the hope that it will be useful,
17 // but WITHOUT ANY WARRANTY; without even the implied warranty of
18 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
19 // GNU General Public License for more details.
20 //
21 // You should have received a copy of the GNU General Public License
22 // along with this program. If not, see <http://www.gnu.org/licenses/>.
23 //-----------------------------------------------------------------------------
24 
25 //-------------------------------------------------------------------------
26 // Filename : $RCSfile: N_NLS_NOX_AugmentLinSys_GStepping.h,v $
27 //
28 // Purpose : Concrete class for augmenting the Jacobian for
29 // pseudo-transient solves.
30 //
31 // Special Notes :
32 //
33 // Creator : Roger Pawlowski, NLS, 9233
34 //
35 // Creation Date : 3/6/2006
36 //
37 // Revision Information:
38 // ---------------------
39 //
40 // Revision Number: $Revision: 1.8 $
41 //
42 // Revision Date : $Date: 2014/02/24 23:49:24 $
43 //
44 // Current Owner : $Author: tvrusso $
45 //-------------------------------------------------------------------------
46 
47 #ifndef Xyce_N_NLS_NOX_AugmentLinSys_GStepping_h
48 #define Xyce_N_NLS_NOX_AugmentLinSys_GStepping_h
49 
50 
51 #include <vector>
52 #include "Teuchos_RefCountPtr.hpp"
53 #include "N_NLS_NOX_AugmentLinSys.h"
54 
55 class Epetra_MapColoring;
56 
57 //-----------------------------------------------------------------------------
58 // Class : N_NLS::NOX::GStepping
59 // Purpose : Handles matrix augmentation to support GMIN stepping.
60 // Creator : Roger Pawlowski, SNL, 9233
61 // Creation Date : 3/6/2006
62 //-----------------------------------------------------------------------------
63 namespace N_NLS_NOX {
64 
66 
67  public:
68 
69  enum NodeListType {
72  };
73 
74  public:
75 
76  //! Ctor for the voltage nodes as a GID list.
77  GStepping(const std::vector<int>& vnodeGIDVec,
78  N_LAS_Vector* cloneVector,
79  double endValue,
80  double residCond=0);
81 
82  //! Ctor with an EpetraMapColoring for all voltage unknowns.
83  GStepping(const Teuchos::RefCountPtr
84  <Epetra_MapColoring>& color_map,
85  N_LAS_Vector* cloneVector,
86  double endValue,
87  double residCond=0);
88 
89  //! Dtor.
90  ~GStepping();
91 
92  void setProgressVariable(double time_step_size);
93 
94  void augmentResidual(const N_LAS_Vector * solution,
95  N_LAS_Vector * residual_vector);
96 
97  void augmentJacobian(N_LAS_Matrix * jacobian);
98 
99  inline void setResidualConductance(double c) {residualConductance_=c;};
100 
101  private:
102 
103  //! Type of list we are using.
105 
106  //! Conductance.
107  double conductance_;
108 
109  //! List of voltage node GIDs.
110  const std::vector<int> vnodeGIDVec_;
111 
112  //! Color 0 are the voltage unknowns.
113  Teuchos::RefCountPtr<Epetra_MapColoring> color_map_;
114 
115  //! Temporary vector used to store diagonal.
116  N_LAS_Vector* tmp_vector_ptr_;
117 
118  //! low end of the exponential term.
120 
121  //! residual value of the conductance. Should almost always be zero
123 
124  };
125 
126 }
127 
128 #endif
129