Stokhos Development
Loading...
Searching...
No Matches
Stokhos::ResponseStatisticModelEvaluator Class Reference

ModelEvaluator providing statistic response functions. More...

#include <Stokhos_ResponseStatisticModelEvaluator.hpp>

Inheritance diagram for Stokhos::ResponseStatisticModelEvaluator:
Collaboration diagram for Stokhos::ResponseStatisticModelEvaluator:

Public Member Functions

 ResponseStatisticModelEvaluator (const Teuchos::RCP< EpetraExt::ModelEvaluator > &me, const Teuchos::Array< Teuchos::RCP< const Epetra_Map > > &base_g_maps, const Teuchos::RCP< const Stokhos::OrthogPolyBasis< int, double > > &sg_basis, const Teuchos::RCP< const EpetraExt::MultiComm > &sg_comm, const Teuchos::RCP< const Epetra_BlockMap > &block_map)

Overridden from EpetraExt::ModelEvaluator .

Teuchos::RCP< EpetraExt::ModelEvaluator > me
 Underlying model evaluator.
Teuchos::Array< Teuchos::RCP< const Epetra_Map > > base_g_maps
 Base maps of block g vectors.
Teuchos::RCP< const Stokhos::OrthogPolyBasis< int, double > > sg_basis
 Stochastic Galerkin basis.
Teuchos::RCP< const EpetraExt::MultiComm > sg_comm
 Parallel SG communicator.
Teuchos::RCP< const Epetra_BlockMap > block_map
 Map for stochastic blocks.
int num_p
 Number of parameters.
int num_g
 Number of responses.
Teuchos::RCP< const Epetra_Map > get_x_map () const
 Return solution vector map.
Teuchos::RCP< const Epetra_Map > get_f_map () const
 Return residual vector map.
Teuchos::RCP< const Epetra_Map > get_p_map (int l) const
 Return parameter vector map.
Teuchos::RCP< const Epetra_Map > get_g_map (int l) const
 Return response map.
Teuchos::RCP< const Teuchos::Array< std::string > > get_p_names (int l) const
 Return array of parameter names.
Teuchos::RCP< const Epetra_Vector > get_p_init (int l) const
 Return initial parameters.
InArgs createInArgs () const
 Create InArgs.
OutArgs createOutArgs () const
 Create OutArgs.
void evalModel (const InArgs &inArgs, const OutArgs &outArgs) const
 Evaluate model on InArgs.

Detailed Description

ModelEvaluator providing statistic response functions.

ResponseStatisticModelEvaluator is an implementation of EpetraExt::ModelEvaluator that wraps a response-only model evaluator and provides additional response functions that are statistics of some other stochastic response. Since it is designed to support derivatives w.r.t. the PCE coefficients of the parameters, the underlying model evaluator should be a block model evaluator.

Member Function Documentation

◆ createInArgs()

EpetraExt::ModelEvaluator::InArgs Stokhos::ResponseStatisticModelEvaluator::createInArgs ( ) const

Create InArgs.

References me, and num_p.

◆ createOutArgs()

EpetraExt::ModelEvaluator::OutArgs Stokhos::ResponseStatisticModelEvaluator::createOutArgs ( ) const

Create OutArgs.

References me, num_g, and num_p.

◆ evalModel()

void Stokhos::ResponseStatisticModelEvaluator::evalModel ( const InArgs & inArgs,
const OutArgs & outArgs ) const

◆ get_g_map()

Teuchos::RCP< const Epetra_Map > Stokhos::ResponseStatisticModelEvaluator::get_g_map ( int l) const

Return response map.

References base_g_maps, me, and num_g.

◆ get_p_init()

Teuchos::RCP< const Epetra_Vector > Stokhos::ResponseStatisticModelEvaluator::get_p_init ( int l) const

Return initial parameters.

References me, and num_p.

◆ get_p_map()

Teuchos::RCP< const Epetra_Map > Stokhos::ResponseStatisticModelEvaluator::get_p_map ( int l) const

Return parameter vector map.

References me, and num_p.

◆ get_p_names()

Teuchos::RCP< const Teuchos::Array< std::string > > Stokhos::ResponseStatisticModelEvaluator::get_p_names ( int l) const

Return array of parameter names.

References me, and num_p.

Member Data Documentation

◆ base_g_maps

Teuchos::Array< Teuchos::RCP<const Epetra_Map> > Stokhos::ResponseStatisticModelEvaluator::base_g_maps
protected

Base maps of block g vectors.

Referenced by evalModel(), and get_g_map().

◆ block_map

Teuchos::RCP<const Epetra_BlockMap> Stokhos::ResponseStatisticModelEvaluator::block_map
protected

Map for stochastic blocks.

Referenced by evalModel().

◆ me

Teuchos::RCP<EpetraExt::ModelEvaluator> Stokhos::ResponseStatisticModelEvaluator::me
protected

Underlying model evaluator.

Referenced by createInArgs(), createOutArgs(), evalModel(), get_g_map(), get_p_init(), get_p_map(), and get_p_names().

◆ num_g

int Stokhos::ResponseStatisticModelEvaluator::num_g
protected

Number of responses.

Referenced by createOutArgs(), evalModel(), and get_g_map().

◆ num_p

int Stokhos::ResponseStatisticModelEvaluator::num_p
protected

Number of parameters.

Referenced by createInArgs(), createOutArgs(), evalModel(), get_p_init(), get_p_map(), and get_p_names().

◆ sg_basis

Teuchos::RCP<const Stokhos::OrthogPolyBasis<int, double> > Stokhos::ResponseStatisticModelEvaluator::sg_basis
protected

Stochastic Galerkin basis.

Referenced by evalModel().

◆ sg_comm

Teuchos::RCP<const EpetraExt::MultiComm> Stokhos::ResponseStatisticModelEvaluator::sg_comm
protected

Parallel SG communicator.

Referenced by evalModel().


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