Public Member Functions | Protected Attributes | Private Member Functions

Aeras::ShallowWaterProblem Class Reference

Abstract interface for representing a 1-D finite element problem. More...

#include <Aeras_ShallowWaterProblem.hpp>

Inheritance diagram for Aeras::ShallowWaterProblem:
Inheritance graph
[legend]
Collaboration diagram for Aeras::ShallowWaterProblem:
Collaboration graph
[legend]

List of all members.

Public Member Functions

 ShallowWaterProblem (const Teuchos::RCP< Teuchos::ParameterList > &params, const Teuchos::RCP< ParamLib > &paramLib, const int spatialDim_)
 Default constructor.
 ~ShallowWaterProblem ()
 Destructor.
virtual int spatialDimension () const
 Return number of spatial dimensions.
virtual void buildProblem (Teuchos::ArrayRCP< Teuchos::RCP< Albany::MeshSpecsStruct > > meshSpecs, Albany::StateManager &stateMgr)
 Build the PDE instantiations, boundary conditions, and initial solution.
virtual Teuchos::Array
< Teuchos::RCP< const
PHX::FieldTag > > 
buildEvaluators (PHX::FieldManager< PHAL::AlbanyTraits > &fm0, const Albany::MeshSpecsStruct &meshSpecs, Albany::StateManager &stateMgr, Albany::FieldManagerChoice fmchoice, const Teuchos::RCP< Teuchos::ParameterList > &responseList)
Teuchos::RCP< const
Teuchos::ParameterList > 
getValidProblemParameters () const
 Each problem must generate it's list of valide parameters.
template<typename EvalT >
Teuchos::RCP< const PHX::FieldTag > constructEvaluators (PHX::FieldManager< PHAL::AlbanyTraits > &fm0, const Albany::MeshSpecsStruct &meshSpecs, Albany::StateManager &stateMgr, Albany::FieldManagerChoice fmchoice, const Teuchos::RCP< Teuchos::ParameterList > &responseList)
 Main problem setup routine. Not directly called, but indirectly by following functions.
void constructDirichletEvaluators (const Albany::MeshSpecsStruct &meshSpecs)
void constructNeumannEvaluators (const Teuchos::RCP< Albany::MeshSpecsStruct > &meshSpecs)

Protected Attributes

int spatialDim
int modelDim
Teuchos::RCP< Albany::Layoutsdl

Private Member Functions

 ShallowWaterProblem (const ShallowWaterProblem &)
 Private to prohibit copying.
ShallowWaterProblemoperator= (const ShallowWaterProblem &)
 Private to prohibit copying.

Detailed Description

Abstract interface for representing a 1-D finite element problem.

Definition at line 25 of file Aeras_ShallowWaterProblem.hpp.


Constructor & Destructor Documentation

Aeras::ShallowWaterProblem::ShallowWaterProblem ( const Teuchos::RCP< Teuchos::ParameterList > &  params,
const Teuchos::RCP< ParamLib > &  paramLib,
const int  spatialDim_ 
)

Default constructor.

Definition at line 18 of file Aeras_ShallowWaterProblem.cpp.

Aeras::ShallowWaterProblem::~ShallowWaterProblem (  ) 

Destructor.

Definition at line 34 of file Aeras_ShallowWaterProblem.cpp.

Aeras::ShallowWaterProblem::ShallowWaterProblem ( const ShallowWaterProblem  )  [private]

Private to prohibit copying.


Member Function Documentation

virtual int Aeras::ShallowWaterProblem::spatialDimension (  )  const [inline, virtual]

Return number of spatial dimensions.

Implements Albany::AbstractProblem.

Definition at line 37 of file Aeras_ShallowWaterProblem.hpp.

void Aeras::ShallowWaterProblem::buildProblem ( Teuchos::ArrayRCP< Teuchos::RCP< Albany::MeshSpecsStruct > >  meshSpecs,
Albany::StateManager stateMgr 
) [virtual]

Build the PDE instantiations, boundary conditions, and initial solution.

Definition at line 40 of file Aeras_ShallowWaterProblem.cpp.

Teuchos::Array< Teuchos::RCP< const PHX::FieldTag > > Aeras::ShallowWaterProblem::buildEvaluators ( PHX::FieldManager< PHAL::AlbanyTraits > &  fm0,
const Albany::MeshSpecsStruct meshSpecs,
Albany::StateManager stateMgr,
Albany::FieldManagerChoice  fmchoice,
const Teuchos::RCP< Teuchos::ParameterList > &  responseList 
) [virtual]

Implements Albany::AbstractProblem.

Definition at line 60 of file Aeras_ShallowWaterProblem.cpp.

Teuchos::RCP< const Teuchos::ParameterList > Aeras::ShallowWaterProblem::getValidProblemParameters (  )  const [virtual]

Each problem must generate it's list of valide parameters.

Reimplemented from Albany::AbstractProblem.

Definition at line 156 of file Aeras_ShallowWaterProblem.cpp.

ShallowWaterProblem& Aeras::ShallowWaterProblem::operator= ( const ShallowWaterProblem  )  [private]

Private to prohibit copying.

template<typename EvalT >
Teuchos::RCP< const PHX::FieldTag > Aeras::ShallowWaterProblem::constructEvaluators ( PHX::FieldManager< PHAL::AlbanyTraits > &  fm0,
const Albany::MeshSpecsStruct meshSpecs,
Albany::StateManager stateMgr,
Albany::FieldManagerChoice  fmchoice,
const Teuchos::RCP< Teuchos::ParameterList > &  responseList 
)

Main problem setup routine. Not directly called, but indirectly by following functions.

Definition at line 106 of file Aeras_ShallowWaterProblem.hpp.

void Aeras::ShallowWaterProblem::constructDirichletEvaluators ( const Albany::MeshSpecsStruct meshSpecs  ) 

Definition at line 76 of file Aeras_ShallowWaterProblem.cpp.

void Aeras::ShallowWaterProblem::constructNeumannEvaluators ( const Teuchos::RCP< Albany::MeshSpecsStruct > &  meshSpecs  ) 

Definition at line 91 of file Aeras_ShallowWaterProblem.cpp.


Member Data Documentation

Definition at line 79 of file Aeras_ShallowWaterProblem.hpp.

Definition at line 80 of file Aeras_ShallowWaterProblem.hpp.

Definition at line 81 of file Aeras_ShallowWaterProblem.hpp.


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