Public Types | Public Member Functions | Private Member Functions | Private Attributes

QCAD::SchrodingerPotential< EvalT, Traits > Class Template Reference

Evaluates Poisson Source Term. More...

#include <QCAD_SchrodingerPotential.hpp>

Collaboration diagram for QCAD::SchrodingerPotential< EvalT, Traits >:
Collaboration graph
[legend]

List of all members.

Public Types

typedef EvalT::ScalarT ScalarT
typedef EvalT::MeshScalarT MeshScalarT

Public Member Functions

 SchrodingerPotential (Teuchos::ParameterList &p, const Teuchos::RCP< Albany::Layouts > &dl)
void postRegistrationSetup (typename Traits::SetupData d, PHX::FieldManager< Traits > &vm)
void evaluateFields (typename Traits::EvalData d)
ScalarTgetValue (const std::string &n)
 Function to allow parameters to be exposed for embedded analysis.

Private Member Functions

Teuchos::RCP< const
Teuchos::ParameterList > 
getValidSchrodingerPotentialParameters () const
 Reference parameter list generator to check xml input file.
ScalarT parabolicPotentialValue (const int numDim, const MeshScalarT *coord)
ScalarT finiteWallPotential (const int numDim, const MeshScalarT *coord)
ScalarT stringFormulaPotential (const int numDim, const MeshScalarT *coord)

Private Attributes

std::size_t numQPs
 input
std::size_t numDims
PHX::MDField< MeshScalarT,
Cell, QuadPoint, Dim
coordVec
PHX::MDField< ScalarT, Cell,
QuadPoint
psi
PHX::MDField< ScalarT, Cell,
QuadPoint
V
 output
ScalarT E0
 energy parameter of potential, precise meaning dependent on type of potential:
std::string stringFormula
 ! specific parameters for string formula
double barrEffMass
 specific parameters for Finite Wall
double barrWidth
double wellEffMass
double wellWidth
ScalarT scalingFactor
 constant scaling of potential
std::string potentialType
std::string potentialStateName
double energy_unit_in_eV
 units
double length_unit_in_m

Detailed Description

template<typename EvalT, typename Traits>
class QCAD::SchrodingerPotential< EvalT, Traits >

Evaluates Poisson Source Term.

Definition at line 28 of file QCAD_SchrodingerPotential.hpp.


Member Typedef Documentation

template<typename EvalT, typename Traits>
typedef EvalT::ScalarT QCAD::SchrodingerPotential< EvalT, Traits >::ScalarT

Definition at line 34 of file QCAD_SchrodingerPotential.hpp.

template<typename EvalT, typename Traits>
typedef EvalT::MeshScalarT QCAD::SchrodingerPotential< EvalT, Traits >::MeshScalarT

Definition at line 35 of file QCAD_SchrodingerPotential.hpp.


Constructor & Destructor Documentation

template<typename EvalT , typename Traits >
QCAD::SchrodingerPotential< EvalT, Traits >::SchrodingerPotential ( Teuchos::ParameterList &  p,
const Teuchos::RCP< Albany::Layouts > &  dl 
)

Definition at line 15 of file QCAD_SchrodingerPotential_Def.hpp.


Member Function Documentation

template<typename EvalT , typename Traits>
void QCAD::SchrodingerPotential< EvalT, Traits >::postRegistrationSetup ( typename Traits::SetupData  d,
PHX::FieldManager< Traits > &  vm 
)

Definition at line 69 of file QCAD_SchrodingerPotential_Def.hpp.

template<typename EvalT , typename Traits>
void QCAD::SchrodingerPotential< EvalT, Traits >::evaluateFields ( typename Traits::EvalData  d  ) 

Definition at line 80 of file QCAD_SchrodingerPotential_Def.hpp.

template<typename EvalT , typename Traits >
QCAD::SchrodingerPotential< EvalT, Traits >::ScalarT & QCAD::SchrodingerPotential< EvalT, Traits >::getValue ( const std::string &  n  ) 

Function to allow parameters to be exposed for embedded analysis.

Definition at line 155 of file QCAD_SchrodingerPotential_Def.hpp.

template<typename EvalT , typename Traits >
Teuchos::RCP< const Teuchos::ParameterList > QCAD::SchrodingerPotential< EvalT, Traits >::getValidSchrodingerPotentialParameters (  )  const [private]

Reference parameter list generator to check xml input file.

Definition at line 165 of file QCAD_SchrodingerPotential_Def.hpp.

template<typename EvalT , typename Traits >
QCAD::SchrodingerPotential< EvalT, Traits >::ScalarT QCAD::SchrodingerPotential< EvalT, Traits >::parabolicPotentialValue ( const int  numDim,
const MeshScalarT coord 
) [private]

Definition at line 202 of file QCAD_SchrodingerPotential_Def.hpp.

template<typename EvalT , typename Traits >
QCAD::SchrodingerPotential< EvalT, Traits >::ScalarT QCAD::SchrodingerPotential< EvalT, Traits >::finiteWallPotential ( const int  numDim,
const MeshScalarT coord 
) [private]

Definition at line 234 of file QCAD_SchrodingerPotential_Def.hpp.

template<typename EvalT , typename Traits >
QCAD::SchrodingerPotential< EvalT, Traits >::ScalarT QCAD::SchrodingerPotential< EvalT, Traits >::stringFormulaPotential ( const int  numDim,
const MeshScalarT coord 
) [private]

Definition at line 295 of file QCAD_SchrodingerPotential_Def.hpp.


Member Data Documentation

template<typename EvalT, typename Traits>
std::size_t QCAD::SchrodingerPotential< EvalT, Traits >::numQPs [private]

input

Definition at line 59 of file QCAD_SchrodingerPotential.hpp.

template<typename EvalT, typename Traits>
std::size_t QCAD::SchrodingerPotential< EvalT, Traits >::numDims [private]

Definition at line 60 of file QCAD_SchrodingerPotential.hpp.

template<typename EvalT, typename Traits>
PHX::MDField<MeshScalarT,Cell,QuadPoint,Dim> QCAD::SchrodingerPotential< EvalT, Traits >::coordVec [private]

Definition at line 61 of file QCAD_SchrodingerPotential.hpp.

template<typename EvalT, typename Traits>
PHX::MDField<ScalarT,Cell,QuadPoint> QCAD::SchrodingerPotential< EvalT, Traits >::psi [private]

Definition at line 62 of file QCAD_SchrodingerPotential.hpp.

template<typename EvalT, typename Traits>
PHX::MDField<ScalarT,Cell,QuadPoint> QCAD::SchrodingerPotential< EvalT, Traits >::V [private]

output

Definition at line 65 of file QCAD_SchrodingerPotential.hpp.

template<typename EvalT, typename Traits>
ScalarT QCAD::SchrodingerPotential< EvalT, Traits >::E0 [private]

energy parameter of potential, precise meaning dependent on type of potential:

Definition at line 70 of file QCAD_SchrodingerPotential.hpp.

template<typename EvalT, typename Traits>
std::string QCAD::SchrodingerPotential< EvalT, Traits >::stringFormula [private]

! specific parameters for string formula

Definition at line 73 of file QCAD_SchrodingerPotential.hpp.

template<typename EvalT, typename Traits>
double QCAD::SchrodingerPotential< EvalT, Traits >::barrEffMass [private]

specific parameters for Finite Wall

Definition at line 76 of file QCAD_SchrodingerPotential.hpp.

template<typename EvalT, typename Traits>
double QCAD::SchrodingerPotential< EvalT, Traits >::barrWidth [private]

Definition at line 77 of file QCAD_SchrodingerPotential.hpp.

template<typename EvalT, typename Traits>
double QCAD::SchrodingerPotential< EvalT, Traits >::wellEffMass [private]

Definition at line 78 of file QCAD_SchrodingerPotential.hpp.

template<typename EvalT, typename Traits>
double QCAD::SchrodingerPotential< EvalT, Traits >::wellWidth [private]

Definition at line 79 of file QCAD_SchrodingerPotential.hpp.

template<typename EvalT, typename Traits>
ScalarT QCAD::SchrodingerPotential< EvalT, Traits >::scalingFactor [private]

constant scaling of potential

Definition at line 82 of file QCAD_SchrodingerPotential.hpp.

template<typename EvalT, typename Traits>
std::string QCAD::SchrodingerPotential< EvalT, Traits >::potentialType [private]

Definition at line 84 of file QCAD_SchrodingerPotential.hpp.

template<typename EvalT, typename Traits>
std::string QCAD::SchrodingerPotential< EvalT, Traits >::potentialStateName [private]

Definition at line 85 of file QCAD_SchrodingerPotential.hpp.

template<typename EvalT, typename Traits>
double QCAD::SchrodingerPotential< EvalT, Traits >::energy_unit_in_eV [private]

units

Definition at line 88 of file QCAD_SchrodingerPotential.hpp.

template<typename EvalT, typename Traits>
double QCAD::SchrodingerPotential< EvalT, Traits >::length_unit_in_m [private]

Definition at line 88 of file QCAD_SchrodingerPotential.hpp.


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