Xyce
6.1
Main Page
Related Pages
Modules
Namespaces
Classes
Files
File List
File Members
All
Classes
Namespaces
Files
Functions
Variables
Typedefs
Enumerations
Enumerator
Friends
Macros
Groups
Pages
N_DEV_SpecieSource.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_DEV_SpecieSource.h,v $
27
//
28
// Purpose : This file contains the PDE device instance base class.
29
//
30
// Special Notes :
31
//
32
// Creator : Eric R. Keiter, SNL, Parallel Computational Sciences
33
//
34
// Creation Date : 05/15/01
35
//
36
// Revision Information:
37
// ---------------------
38
//
39
// Revision Number: $Revision: 1.7 $
40
//
41
// Revision Date : $Date: 2014/02/24 23:49:14 $
42
//
43
// Current Owner : $Author: tvrusso $
44
//-----------------------------------------------------------------------------
45
46
#ifndef Xyce_N_DEV_SpecieSource_h
47
#define Xyce_N_DEV_SpecieSource_h
48
49
// ---------- Standard Includes ----------
50
#include <N_UTL_Misc.h>
51
52
// ---------- Xyce Includes ----------
53
#include <
N_DEV_fwd.h
>
54
#include <
N_DEV_Const.h
>
55
#include <
N_DEV_CompositeParam.h
>
56
57
namespace
Xyce {
58
namespace
Device {
59
60
61
//-----------------------------------------------------------------------------
62
// Class : SpecieSource
63
// Purpose :
64
// Special Notes :
65
// Creator : Eric Keiter, SNL
66
// Creation Date :
67
//-----------------------------------------------------------------------------
68
class
SpecieSource
:
public
CompositeParam
69
{
70
friend
class
ParametricData
<
SpecieSource
>;
71
72
public
:
73
static
ParametricData<SpecieSource>
&
getParametricData
();
74
75
SpecieSource
();
76
bool
processParam
(
Param
& ndParam, std::string & param,
DevicePDEInstance
& di);
77
void
processParams
();
78
79
public
:
80
std::string
name
;
// this is also the index into the map.
81
};
82
83
// inline functions
84
//-----------------------------------------------------------------------------
85
// Function : SpecieSource::operator<<
86
// Purpose : "<<" operator
87
// Special Notes :
88
// Scope : public
89
// Creator : Eric R. Keiter, SNL
90
// Creation Date :
91
//-----------------------------------------------------------------------------
92
inline
std::ostream &
operator<<
(std::ostream & os,
const
SpecieSource
& ds)
93
{
94
os << ds.
name
<<
":\n"
;
95
os << std::endl;
96
return
os;
97
}
98
99
}
// namespace Device
100
}
// namespace Xyce
101
102
typedef
Xyce::Device::SpecieSource
N_DEV_SpecieSource
;
103
104
#endif
105
src
DeviceModelPKG
Core
include
N_DEV_SpecieSource.h
Generated on Mon Mar 24 2014 10:54:39 for Xyce by
1.8.3.1