Public Member Functions | Protected Attributes | Private Member Functions

Albany::CahnHillProblem Class Reference

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

#include <Albany_CahnHillProblem.hpp>

Inheritance diagram for Albany::CahnHillProblem:
Inheritance graph
[legend]
Collaboration diagram for Albany::CahnHillProblem:
Collaboration graph
[legend]

List of all members.

Public Member Functions

 CahnHillProblem (const Teuchos::RCP< Teuchos::ParameterList > &params, const Teuchos::RCP< ParamLib > &paramLib, const int numDim_, const Teuchos::RCP< const Epetra_Comm > &comm_)
 Default constructor.
 ~CahnHillProblem ()
 Destructor.
virtual int spatialDimension () const
 Return number of spatial dimensions.
virtual void buildProblem (Teuchos::ArrayRCP< Teuchos::RCP< Albany::MeshSpecsStruct > > meshSpecs, 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 valid 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 std::vector< std::string > &nodeSetIDs)

Protected Attributes

int numDim
bool haveNoise
Teuchos::RCP< const Epetra_Comm > comm
Teuchos::RCP< Albany::Layoutsdl

Private Member Functions

 CahnHillProblem (const CahnHillProblem &)
 Private to prohibit copying.
CahnHillProblemoperator= (const CahnHillProblem &)
 Private to prohibit copying.

Detailed Description

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

Definition at line 26 of file Albany_CahnHillProblem.hpp.


Constructor & Destructor Documentation

Albany::CahnHillProblem::CahnHillProblem ( const Teuchos::RCP< Teuchos::ParameterList > &  params,
const Teuchos::RCP< ParamLib > &  paramLib,
const int  numDim_,
const Teuchos::RCP< const Epetra_Comm > &  comm_ 
)

Default constructor.

Definition at line 17 of file Albany_CahnHillProblem.cpp.

Albany::CahnHillProblem::~CahnHillProblem (  ) 

Destructor.

Definition at line 29 of file Albany_CahnHillProblem.cpp.

Albany::CahnHillProblem::CahnHillProblem ( const CahnHillProblem  )  [private]

Private to prohibit copying.


Member Function Documentation

virtual int Albany::CahnHillProblem::spatialDimension (  )  const [inline, virtual]

Return number of spatial dimensions.

Implements Albany::AbstractProblem.

Definition at line 39 of file Albany_CahnHillProblem.hpp.

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

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

Implements Albany::AbstractProblem.

Definition at line 35 of file Albany_CahnHillProblem.cpp.

Teuchos::Array< Teuchos::RCP< const PHX::FieldTag > > Albany::CahnHillProblem::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 55 of file Albany_CahnHillProblem.cpp.

Teuchos::RCP< const Teuchos::ParameterList > Albany::CahnHillProblem::getValidProblemParameters (  )  const [virtual]

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

Reimplemented from Albany::AbstractProblem.

Definition at line 83 of file Albany_CahnHillProblem.cpp.

CahnHillProblem& Albany::CahnHillProblem::operator= ( const CahnHillProblem  )  [private]

Private to prohibit copying.

template<typename EvalT >
Teuchos::RCP< const PHX::FieldTag > Albany::CahnHillProblem::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 110 of file Albany_CahnHillProblem.hpp.

void Albany::CahnHillProblem::constructDirichletEvaluators ( const std::vector< std::string > &  nodeSetIDs  ) 

Definition at line 72 of file Albany_CahnHillProblem.cpp.


Member Data Documentation

Definition at line 82 of file Albany_CahnHillProblem.hpp.

Definition at line 84 of file Albany_CahnHillProblem.hpp.

Teuchos::RCP<const Epetra_Comm> Albany::CahnHillProblem::comm [protected]

Definition at line 86 of file Albany_CahnHillProblem.hpp.

Teuchos::RCP<Albany::Layouts> Albany::CahnHillProblem::dl [protected]

Definition at line 88 of file Albany_CahnHillProblem.hpp.


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