PanNDE
All Classes Namespaces Functions Pages
Public Member Functions | List of all members
HostData::HostFieldBundle Class Reference

#include "modules/HostData/include/HostField.hpp"

Inheritance diagram for HostData::HostFieldBundle:
PanNDE::FieldBundle

Public Member Functions

std::shared_ptr< PanNDE::Mesh > & mesh () override
 
std::shared_ptr< PanNDE::Fieldfield (std::string keyname) override
 
std::string fieldName (int idx) override
 
int fieldCount () override
 
void emplaceField (std::string keyname, std::shared_ptr< PanNDE::Field > field) override
 
void emplaceField (std::string keyname, PanNDE::Field::FieldType type) override
 
 HostFieldBundle ()
 
 HostFieldBundle (std::shared_ptr< PanNDE::Mesh > bundle_mesh)
 
- Public Member Functions inherited from PanNDE::FieldBundle
virtual void emplaceField (std::string keyname, std::shared_ptr< PanNDE::Field > field)=0
 

Detailed Description

Implements a container for passing related fields with their parent mesh

Constructor & Destructor Documentation

◆ HostFieldBundle() [1/2]

HostData::HostFieldBundle::HostFieldBundle ( )
inline

default constructor

◆ HostFieldBundle() [2/2]

HostData::HostFieldBundle::HostFieldBundle ( std::shared_ptr< PanNDE::Mesh bundle_mesh)
inline

constructor

Parameters
meshfor all fields

Member Function Documentation

◆ emplaceField() [1/2]

void HostData::HostFieldBundle::emplaceField ( std::string  keyname,
PanNDE::Field::FieldType  type 
)
inlineoverridevirtual

emplace new field

Parameters
keynamefield name
typefield type to be constructed

Implements PanNDE::FieldBundle.

◆ emplaceField() [2/2]

void HostData::HostFieldBundle::emplaceField ( std::string  keyname,
std::shared_ptr< PanNDE::Field field 
)
inlineoverride

emplace extant field

Parameters
keynamefield name
fieldfield to be emplaced

◆ field()

std::shared_ptr<PanNDE::Field> HostData::HostFieldBundle::field ( std::string  keyname)
inlineoverridevirtual

get the field by name

Parameters
keynamefield name

Implements PanNDE::FieldBundle.

◆ fieldCount()

int HostData::HostFieldBundle::fieldCount ( )
inlineoverridevirtual

get the number of bundled fields

Implements PanNDE::FieldBundle.

◆ fieldName()

std::string HostData::HostFieldBundle::fieldName ( int  idx)
inlineoverridevirtual

get the field name by index

Parameters
idxindex of the field in underlying storage

Implements PanNDE::FieldBundle.

◆ mesh()

std::shared_ptr<PanNDE::Mesh>& HostData::HostFieldBundle::mesh ( )
inlineoverridevirtual

get the parent mesh

Implements PanNDE::FieldBundle.


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