Nalu: sierra::nalu::Converter Class Reference

Nalu

Nalu: a generalized unstructured massively parallel low Mach flow code designed to support a variety of energy applications of interest (most notably Wind ECP) built on the Sierra Toolkit and Trilinos solver Tpetra/Epetra stack. The open source BSD, clause 3 license model has been chosen for the code base. See LICENSE for more information. http://NaluCFD.org

Provides arbitrary processing of input data before handing off values to a Table for interpolation. More...

#include <Converter.h>

Inheritance diagram for sierra::nalu::Converter:

Public Member Functions
	Converter (const std::string &converterType)

virtual	~Converter ()

const std::string &	name () const
	Get the name of the variable returned by this Converter. More...

const std::vector< std::string > &	input_names () const
	Get the list of input variables, in the order that they are to be provided to the query() call. More...

unsigned int	dimension () const

virtual double	query (const std::vector< double > &inputs) const =0
	Perform the calculation. More...

void	print_summary () const
	Print a summary of this Converter configuration. More...

virtual void	read_hdf5 (H5IO &io)
	Read this Converter from the provided I/O device. More...

Protected Attributes
std::string	name_

std::vector< std::string >	inputNames_

unsigned int	dimension_

Private Member Functions
	Converter (const Converter &)

Private Attributes
const std::string	converterType_

Detailed Description

Provides arbitrary processing of input data before handing off values to a Table for interpolation.

This abstract base class provides an interface for accepting any number of input variables inside a Property object, and calculating an arbitrary new variable for use as an input in the central Table. Derived classes provide the conversion machinery in the query() function.

Constructor & Destructor Documentation

sierra::nalu::Converter::Converter ( const std::string & converterType )

explicit

virtual sierra::nalu::Converter::~Converter ( )

inlinevirtual

sierra::nalu::Converter::Converter ( const Converter & )

private

Member Function Documentation

unsigned int sierra::nalu::Converter::dimension ( ) const

inline

const std::vector<std::string>& sierra::nalu::Converter::input_names ( ) const

inline

Get the list of input variables, in the order that they are to be provided to the query() call.

const std::string& sierra::nalu::Converter::name ( ) const

inline

Get the name of the variable returned by this Converter.

void sierra::nalu::Converter::print_summary ( ) const

Print a summary of this Converter configuration.

References converterType_, inputNames_, and name_.

virtual double sierra::nalu::Converter::query ( const std::vector< double > & inputs ) const

pure virtual

Perform the calculation.

Parameters

inputs : Array of independent variable values

Returns: : The resulting computed value

Implemented in sierra::nalu::HStarConverter, sierra::nalu::DeltaGammaConverter, sierra::nalu::GammaConverter, sierra::nalu::DeltaChiConverter, sierra::nalu::ChiConverter, and sierra::nalu::NameConverter.

void sierra::nalu::Converter::read_hdf5 ( H5IO & io )

virtual

Read this Converter from the provided I/O device.

Reimplemented in sierra::nalu::HStarConverter, sierra::nalu::DeltaGammaConverter, sierra::nalu::GammaConverter, sierra::nalu::DeltaChiConverter, and sierra::nalu::ChiConverter.

References converterType_, dimension_, inputNames_, name_, and sierra::nalu::H5IO::read_attribute().

Referenced by sierra::nalu::ChiConverter::read_hdf5(), sierra::nalu::DeltaChiConverter::read_hdf5(), sierra::nalu::GammaConverter::read_hdf5(), sierra::nalu::DeltaGammaConverter::read_hdf5(), sierra::nalu::HStarConverter::read_hdf5(), and sierra::nalu::HDF5Table::read_hdf5_property().

Member Data Documentation

const std::string sierra::nalu::Converter::converterType_

private

Referenced by print_summary(), and read_hdf5().

unsigned int sierra::nalu::Converter::dimension_

protected

Referenced by sierra::nalu::NameConverter::NameConverter(), and read_hdf5().

std::vector<std::string> sierra::nalu::Converter::inputNames_

protected

Referenced by sierra::nalu::NameConverter::NameConverter(), print_summary(), and read_hdf5().

std::string sierra::nalu::Converter::name_

protected

Referenced by sierra::nalu::NameConverter::NameConverter(), print_summary(), and read_hdf5().

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