Albany::AbstractProblem Class Reference

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

#include <Albany_AbstractProblem.hpp>

Inheritance diagram for Albany::AbstractProblem:

List of all members.

Public Member Functions
	AbstractProblem (const Teuchos::RCP< Teuchos::ParameterList > &params_, const Teuchos::RCP< ParamLib > &paramLib_, const int neq_=0)
	Only constructor.
virtual	~AbstractProblem ()
	Destructor.
unsigned int	numEquations () const
	Get the number of equations.
void	setNumEquations (const int neq_)
unsigned int	numStates () const
virtual int	spatialDimension () const =0
	Get spatial dimension.
virtual void	buildProblem (Teuchos::ArrayRCP< Teuchos::RCP< Albany::MeshSpecsStruct > > meshSpecs, StateManager &stateMgr)=0
	Build the PDE instantiations, boundary conditions, and initial solution And construct the evaluators and field managers.
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)=0
Teuchos::ArrayRCP < Teuchos::RCP < PHX::FieldManager < PHAL::AlbanyTraits > > >	getFieldManager ()
Teuchos::RCP < PHX::FieldManager < PHAL::AlbanyTraits > >	getDirichletFieldManager ()
Teuchos::ArrayRCP < Teuchos::RCP < PHX::FieldManager < PHAL::AlbanyTraits > > >	getNeumannFieldManager ()
const Teuchos::RCP < Piro::MLRigidBodyModes > &	getNullSpace ()
	Return the Null space object used to communicate with MP.
virtual Teuchos::RCP< const Teuchos::ParameterList >	getValidProblemParameters () const
	Each problem must generate it's list of valide parameters.
virtual void	getAllocatedStates (Teuchos::ArrayRCP< Teuchos::ArrayRCP< Teuchos::RCP< Intrepid::FieldContainer< RealType > > > > oldState_, Teuchos::ArrayRCP< Teuchos::ArrayRCP< Teuchos::RCP< Intrepid::FieldContainer< RealType > > > > newState_) const
const AbstractFieldContainer::FieldContainerRequirements	getFieldRequirements ()
	Get a list of the Special fields needed to implement the problem.
Protected Member Functions
Teuchos::RCP < Teuchos::ParameterList >	getGenericProblemParams (std::string listname="ProblemList") const
	List of valid problem params common to all problems, as a starting point for the specific getValidProblemParameters.
Protected Attributes
Teuchos::RCP < Teuchos::FancyOStream >	out
	Configurable output stream, defaults to printing on proc=0.
unsigned int	neq
	Number of equations per node being solved.
Teuchos::RCP < Teuchos::ParameterList >	params
	Problem parameters.
Teuchos::RCP< ParamLib >	paramLib
	Parameter library.
Teuchos::ArrayRCP < Teuchos::RCP < PHX::FieldManager < PHAL::AlbanyTraits > > >	fm
	Field manager for Volumettric Fill.
Teuchos::RCP < PHX::FieldManager < PHAL::AlbanyTraits > >	dfm
	Field manager for Dirchlet Conditions Fill.
Teuchos::ArrayRCP < Teuchos::RCP < PHX::FieldManager < PHAL::AlbanyTraits > > >	nfm
	Field manager for Neumann Conditions Fill.
AbstractFieldContainer::FieldContainerRequirements	requirements
	Special fields needed to implement the problem.
Teuchos::RCP < Piro::MLRigidBodyModes >	rigidBodyModes
	Null space object used to communicate with MP.
Private Member Functions
	AbstractProblem ()
	Private to prohibit default or copy constructor.
	AbstractProblem (const AbstractProblem &)
AbstractProblem &	operator= (const AbstractProblem &)
	Private to prohibit copying.

---

Detailed Description

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

Definition at line 61 of file Albany_AbstractProblem.hpp.

---

Constructor & Destructor Documentation

Albany::AbstractProblem::AbstractProblem	(	const Teuchos::RCP< Teuchos::ParameterList > &	params_,
		const Teuchos::RCP< ParamLib > &	paramLib_,
		const int	neq_ = 0
	)

Only constructor.

Definition at line 10 of file Albany_AbstractProblem.cpp.

virtual Albany::AbstractProblem::~AbstractProblem

(

)

[inline, virtual]

Destructor.

Definition at line 70 of file Albany_AbstractProblem.hpp.

Albany::AbstractProblem::AbstractProblem

(

)

[private]

Private to prohibit default or copy constructor.

Albany::AbstractProblem::AbstractProblem

(

const AbstractProblem &

)

[private]

---

Member Function Documentation

unsigned int Albany::AbstractProblem::numEquations

(

)

const

Get the number of equations.

Definition at line 22 of file Albany_AbstractProblem.cpp.

void Albany::AbstractProblem::setNumEquations

(

const int

neq_

)

Definition at line 31 of file Albany_AbstractProblem.cpp.

unsigned int Albany::AbstractProblem::numStates

(

)

const

virtual int Albany::AbstractProblem::spatialDimension

(

)

const [pure virtual]

Get spatial dimension.

Implemented in Aeras::ShallowWaterProblem, Aeras::XZScalarAdvectionProblem, FELIX::Stokes, FELIX::StokesFO, FELIX::StokesL1L2, Albany::HydMorphProblem, Albany::HydrideProblem, Albany::LaplaceBeltramiProblem, Albany::MesoScaleLinkProblem, Albany::ConcurrentMultiscaleProblem, Albany::ElasticityProblem, Albany::GradientDamageProblem, Albany::LameProblem, Albany::MechanicsProblem, Albany::PeridigmProblem, Albany::PoroElasticityProblem, Albany::ProjectionProblem, Albany::SchwarzMultiscaleProblem, Albany::ThermoElasticityProblem, Albany::ThermoMechanicalProblem, Albany::ThermoPoroPlasticityProblem, Albany::TLPoroPlasticityProblem, Albany::UnSatPoroElasticityProblem, Albany::CahnHillProblem, Albany::ComprNSProblem, Albany::GPAMProblem, Albany::HeatProblem, Albany::Helmholtz2DProblem, Albany::LinComprNSProblem, Albany::NavierStokes, Albany::ODEProblem, Albany::PNPProblem, Albany::ThermoElectrostaticsProblem, QCAD::PoissonProblem, and QCAD::SchrodingerProblem.

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

Build the PDE instantiations, boundary conditions, and initial solution And construct the evaluators and field managers.

Implemented in Albany::HydMorphProblem, Albany::HydrideProblem, Albany::LaplaceBeltramiProblem, Albany::MesoScaleLinkProblem, Albany::ConcurrentMultiscaleProblem, Albany::ElasticityProblem, Albany::GradientDamageProblem, Albany::LameProblem, Albany::MechanicsProblem, Albany::PeridigmProblem, Albany::PoroElasticityProblem, Albany::SchwarzMultiscaleProblem, Albany::ThermoElasticityProblem, Albany::ThermoMechanicalProblem, Albany::ThermoPoroPlasticityProblem, Albany::TLPoroPlasticityProblem, Albany::UnSatPoroElasticityProblem, Albany::CahnHillProblem, Albany::ComprNSProblem, Albany::GPAMProblem, Albany::HeatProblem, Albany::Helmholtz2DProblem, Albany::LinComprNSProblem, Albany::NavierStokes, Albany::ODEProblem, Albany::PNPProblem, and Albany::ThermoElectrostaticsProblem.

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

Implemented in Aeras::ShallowWaterProblem, Aeras::XZScalarAdvectionProblem, FELIX::Stokes, FELIX::StokesFO, FELIX::StokesL1L2, Albany::HydMorphProblem, Albany::HydrideProblem, Albany::LaplaceBeltramiProblem, Albany::MesoScaleLinkProblem, Albany::ConcurrentMultiscaleProblem, Albany::ElasticityProblem, Albany::GradientDamageProblem, Albany::LameProblem, Albany::MechanicsProblem, Albany::PeridigmProblem, Albany::PoroElasticityProblem, Albany::SchwarzMultiscaleProblem, Albany::ThermoElasticityProblem, Albany::ThermoMechanicalProblem, Albany::ThermoPoroPlasticityProblem, Albany::TLPoroPlasticityProblem, Albany::UnSatPoroElasticityProblem, Albany::CahnHillProblem, Albany::ComprNSProblem, Albany::GPAMProblem, Albany::HeatProblem, Albany::Helmholtz2DProblem, Albany::LinComprNSProblem, Albany::NavierStokes, Albany::ODEProblem, Albany::PNPProblem, Albany::ThermoElectrostaticsProblem, QCAD::PoissonProblem, and QCAD::SchrodingerProblem.

Teuchos::ArrayRCP< Teuchos::RCP< PHX::FieldManager< PHAL::AlbanyTraits > > > Albany::AbstractProblem::getFieldManager

(

)

Definition at line 39 of file Albany_AbstractProblem.cpp.

Teuchos::RCP< PHX::FieldManager< PHAL::AlbanyTraits > > Albany::AbstractProblem::getDirichletFieldManager

(

)

Definition at line 43 of file Albany_AbstractProblem.cpp.

Teuchos::ArrayRCP< Teuchos::RCP< PHX::FieldManager< PHAL::AlbanyTraits > > > Albany::AbstractProblem::getNeumannFieldManager

(

)

Definition at line 47 of file Albany_AbstractProblem.cpp.

const Teuchos::RCP<Piro::MLRigidBodyModes>& Albany::AbstractProblem::getNullSpace

(

)

[inline]

Return the Null space object used to communicate with MP.

Definition at line 100 of file Albany_AbstractProblem.hpp.

virtual Teuchos::RCP<const Teuchos::ParameterList> Albany::AbstractProblem::getValidProblemParameters

(

)

const [inline, virtual]

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

Reimplemented in Aeras::ShallowWaterProblem, Aeras::XZScalarAdvectionProblem, FELIX::Stokes, FELIX::StokesFO, FELIX::StokesL1L2, Albany::HydMorphProblem, Albany::HydrideProblem, Albany::LaplaceBeltramiProblem, Albany::MesoScaleLinkProblem, Albany::ConcurrentMultiscaleProblem, Albany::ElasticityProblem, Albany::GradientDamageProblem, Albany::LameProblem, Albany::MechanicsProblem, Albany::PeridigmProblem, Albany::PoroElasticityProblem, Albany::ProjectionProblem, Albany::SchwarzMultiscaleProblem, Albany::ThermoElasticityProblem, Albany::ThermoMechanicalProblem, Albany::ThermoPoroPlasticityProblem, Albany::TLPoroPlasticityProblem, Albany::UnSatPoroElasticityProblem, Albany::CahnHillProblem, Albany::ComprNSProblem, Albany::GPAMProblem, Albany::HeatProblem, Albany::Helmholtz2DProblem, Albany::LinComprNSProblem, Albany::NavierStokes, Albany::ODEProblem, Albany::PNPProblem, Albany::ThermoElectrostaticsProblem, QCAD::PoissonProblem, and QCAD::SchrodingerProblem.

Definition at line 103 of file Albany_AbstractProblem.hpp.

virtual void Albany::AbstractProblem::getAllocatedStates	(	Teuchos::ArrayRCP< Teuchos::ArrayRCP< Teuchos::RCP< Intrepid::FieldContainer< RealType > > > >	oldState_,
		Teuchos::ArrayRCP< Teuchos::ArrayRCP< Teuchos::RCP< Intrepid::FieldContainer< RealType > > > >	newState_
	)			const [inline, virtual]

Reimplemented in Albany::MesoScaleLinkProblem, Albany::ElasticityProblem, Albany::GradientDamageProblem, Albany::PoroElasticityProblem, Albany::ThermoElasticityProblem, Albany::ThermoMechanicalProblem, Albany::ThermoPoroPlasticityProblem, Albany::TLPoroPlasticityProblem, and Albany::UnSatPoroElasticityProblem.

Definition at line 107 of file Albany_AbstractProblem.hpp.

const AbstractFieldContainer::FieldContainerRequirements Albany::AbstractProblem::getFieldRequirements

(

)

[inline]

Get a list of the Special fields needed to implement the problem.

Definition at line 113 of file Albany_AbstractProblem.hpp.

Teuchos::RCP< Teuchos::ParameterList > Albany::AbstractProblem::getGenericProblemParams

(

std::string

listname = "ProblemList"

)

const [protected]

List of valid problem params common to all problems, as a starting point for the specific getValidProblemParameters.

Definition at line 51 of file Albany_AbstractProblem.cpp.

AbstractProblem& Albany::AbstractProblem::operator=

(

const AbstractProblem &

)

[private]

Private to prohibit copying.

---

Member Data Documentation

Teuchos::RCP<Teuchos::FancyOStream> Albany::AbstractProblem::out [protected]

Configurable output stream, defaults to printing on proc=0.

Definition at line 123 of file Albany_AbstractProblem.hpp.

unsigned int Albany::AbstractProblem::neq [protected]

Number of equations per node being solved.

Definition at line 126 of file Albany_AbstractProblem.hpp.

Teuchos::RCP<Teuchos::ParameterList> Albany::AbstractProblem::params [protected]

Problem parameters.

Definition at line 129 of file Albany_AbstractProblem.hpp.

Teuchos::RCP<ParamLib> Albany::AbstractProblem::paramLib [protected]

Parameter library.

Definition at line 132 of file Albany_AbstractProblem.hpp.

Teuchos::ArrayRCP<Teuchos::RCP<PHX::FieldManager<PHAL::AlbanyTraits> > > Albany::AbstractProblem::fm [protected]

Field manager for Volumettric Fill.

Definition at line 135 of file Albany_AbstractProblem.hpp.

Teuchos::RCP<PHX::FieldManager<PHAL::AlbanyTraits> > Albany::AbstractProblem::dfm [protected]

Field manager for Dirchlet Conditions Fill.

Definition at line 138 of file Albany_AbstractProblem.hpp.

Teuchos::ArrayRCP<Teuchos::RCP<PHX::FieldManager<PHAL::AlbanyTraits> > > Albany::AbstractProblem::nfm [protected]

Field manager for Neumann Conditions Fill.

Definition at line 141 of file Albany_AbstractProblem.hpp.

AbstractFieldContainer::FieldContainerRequirements Albany::AbstractProblem::requirements [protected]

Special fields needed to implement the problem.

Definition at line 144 of file Albany_AbstractProblem.hpp.

Teuchos::RCP<Piro::MLRigidBodyModes> Albany::AbstractProblem::rigidBodyModes [protected]

Null space object used to communicate with MP.

Definition at line 147 of file Albany_AbstractProblem.hpp.

---

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

• Albany_AbstractProblem.hpp
• Albany_AbstractProblem.cpp