VertexCFD::Mesh::StkReaderFactory Class Reference

#include <VertexCFD_Mesh_StkReaderFactory.hpp>

Inheritance diagram for VertexCFD::Mesh::StkReaderFactory:

Collaboration diagram for VertexCFD::Mesh::StkReaderFactory:

Public Member Functions
	StkReaderFactory (const std::string &file_name, const int restart_index=0, const bool is_exodus=true)
	Ctor. More...
virtual Teuchos::RCP< panzer_stk::STK_Interface >	buildMesh (stk::ParallelMachine parallel_mach) const override
virtual Teuchos::RCP< panzer_stk::STK_Interface >	buildUncommitedMesh (stk::ParallelMachine parallel_mach) const override
virtual void	completeMeshConstruction (panzer_stk::STK_Interface &mesh, stk::ParallelMachine parallel_mach) const override
void	setParameterList (const Teuchos::RCP< Teuchos::ParameterList > &param_list) override
	From ParameterListAcceptor. More...
Teuchos::RCP< const Teuchos::ParameterList >	getValidParameters () const override
	From ParameterListAcceptor.
const std::string &	getFileName () const
	Get file name mean is read from.

Protected Member Functions
void	registerElementBlocks (panzer_stk::STK_Interface &mesh, stk::io::StkMeshIoBroker &mesh_data) const
void	registerSidesets (panzer_stk::STK_Interface &mesh) const
void	registerNodesets (panzer_stk::STK_Interface &mesh) const

Protected Attributes
std::string	file_name_
std::string	decomp_method_
int	restart_index_
bool	is_exodus_

Detailed Description

Concrete mesh factory instantiation. This reads a mesh from an exodus file and builds a STK_Interface object.

Also, if a nonzero restart index (the Exodus indices are 1 based) is specified then this will set the initial state time in the STK_Interface. However, as prescribed by that interface the currentStateTime is only set by the writeToExodus call, thus the currentStateTime of the created STK_Interface object will be zero. It is up to the user to rectify this when calling writeToExodus.

Constructor & Destructor Documentation

StkReaderFactory()

VertexCFD::Mesh::StkReaderFactory::StkReaderFactory	(	const std::string &	file_name,
		const int	restart_index = 0,
		const bool	is_exodus = true
	)

Ctor.

Parameters

[in]	file_name	Name of the input file.
[in]	restart_index	Index used for restarts.
[in]	is_exodus	If true, the input file is in exodus format. If false, it assumes CGNS format.

Member Function Documentation

buildMesh()

Teuchos::RCP< panzer_stk::STK_Interface > VertexCFD::Mesh::StkReaderFactory::buildMesh ( stk::ParallelMachine  parallel_mach ) const

overridevirtual

Construct a STK_Inteface object described by this factory.

Parameters

[in]

parallel_mach

Descriptor for machine to build this mesh on.

Returns

Pointer to STK_Interface object with isModifiable()==false.

buildUncommitedMesh()

Teuchos::RCP< panzer_stk::STK_Interface > VertexCFD::Mesh::StkReaderFactory::buildUncommitedMesh ( stk::ParallelMachine  parallel_mach ) const

overridevirtual

This builds all the meta data of the mesh. Does not call metaData->commit. Allows user to add solution fields and other pieces. The mesh can be "completed" by calling completeMeshConstruction.

completeMeshConstruction()

void VertexCFD::Mesh::StkReaderFactory::completeMeshConstruction ( panzer_stk::STK_Interface &  mesh, stk::ParallelMachine  parallel_mach  ) const

overridevirtual

Finishes building a mesh object started by buildUncommitedMesh.

setParameterList()

void VertexCFD::Mesh::StkReaderFactory::setParameterList ( const Teuchos::RCP< Teuchos::ParameterList > &  param_list )

override

From ParameterListAcceptor.

From ParameterListAcceptor. Must be called if the empty ctor is used to construct this object.

---

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

• src/mesh/VertexCFD_Mesh_StkReaderFactory.hpp
• src/mesh/VertexCFD_Mesh_StkReaderFactory.cpp