Xyce  6.1
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
N_NLS_NOX_AugmentLinSys_PseudoTransient.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_PseudoTransient.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.6 $
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_PseudoTransient_h
48 #define Xyce_N_NLS_NOX_AugmentLinSys_PseudoTransient_h
49 
50 //-----------------------------------------------------------------------------
51 // Class : N_NLS::NOX::
52 //
53 // Purpose :
54 //
55 // NOX Group Interface for Xyce
56 //
57 // Creator : Roger Pawlowski, SNL, 9233
58 //
59 // Creation Date : 3/6/2006
60 //-----------------------------------------------------------------------------
61 
62 #include "Teuchos_RefCountPtr.hpp"
63 #include "N_NLS_NOX_AugmentLinSys.h"
64 
65 class Epetra_MapColoring;
66 
67 namespace N_NLS_NOX {
68 
70 
71 public:
72 
73  //! Ctor.
74  AugmentLinSysPseudoTransient(const Teuchos::RefCountPtr<Epetra_MapColoring>&
75  color_map,
76  N_LAS_Vector* cloneVector,
77  bool useVoltageScaleFactor=false,
78  double voltageScaleFactor=1.0);
79 
80  //! Dtor.
82 
83  void setProgressVariable(double time_step_size);
84 
85  void augmentResidual(const N_LAS_Vector * solution,
86  N_LAS_Vector * residual_vector);
87 
88  void augmentJacobian(N_LAS_Matrix * jacobian);
89 
90  private:
91 
93 
95 
97 
98  Teuchos::RefCountPtr<Epetra_MapColoring> color_map_;
99 
100  N_LAS_Vector* tmp_vector_ptr_;
101 
102 };
103 
104 }
105 
106 #endif
107