NEM::DRV::ProteusDriver Class Reference

Driver to read Proteus output. More...

Detailed Description

Converts Proteus HDF mesh to VTK/Exodus format

Definition at line 42 of file ProteusDriver.H.

Classes
struct	Files
struct	Opts

Public Member Functions
	ProteusDriver (Files files, Opts opts)
const Files &	getFiles () const
void	setFiles (Files files)
const Opts &	getOpts () const
void	setOpts (Opts opts)
void	execute () const override
	Run the workflow represented by the driver. More...
	~ProteusDriver () override

Static Public Member Functions
static std::unique_ptr< NemDriver >	readJSON (const jsoncons::json &inputjson)
	Factory method for all drivers. More...

Private Member Functions
	ProteusDriver ()
jsoncons::string_view	getProgramType () const override

Private Attributes
Files	files_
Opts	opts_

Static Private Attributes
static constexpr const char *	programType = "Proteus"

Inherits NEM::DRV::NemDriver.

Constructor & Destructor Documentation

ProteusDriver() [1/2]

NEM::DRV::ProteusDriver::ProteusDriver	(	Files	files,
		Opts	opts
	)

Definition at line 46 of file ProteusDriver.C.

    : files_(std::move(files)), opts_(std::move(opts)) {
  std::cout << "ProteusDriver created\n";
}

~ProteusDriver()

NEM::DRV::ProteusDriver::~ProteusDriver ( )

override

Definition at line 61 of file ProteusDriver.C.

                              {
  std::cout << "ProteusDriver destroyed" << std::endl;
}

ProteusDriver() [2/2]

NEM::DRV::ProteusDriver::ProteusDriver ( )

private

Definition at line 51 of file ProteusDriver.C.

: ProteusDriver({{}, {}, {}}, Opts{{}}) {}

Member Function Documentation

execute()

void NEM::DRV::ProteusDriver::execute ( ) const

overridevirtual

Implements NEM::DRV::NemDriver.

Definition at line 69 of file ProteusDriver.C.

References NEM::DRV::ProteusDriver::Files::fieldFName, and files_.

                                  {
  proteusHdf5(this->files_.fieldFName, this->files_.meshFName,
              this->opts_.edgeSidesetName, this->files_.exoMeshFName,
              this->opts_.lowOrder, this->opts_.bndryConst);
}

getFiles()

const ProteusDriver::Files & NEM::DRV::ProteusDriver::getFiles

(

)

const

Definition at line 53 of file ProteusDriver.C.

References files_.

{ return files_; }

getOpts()

const ProteusDriver::Opts & NEM::DRV::ProteusDriver::getOpts

(

)

const

Definition at line 57 of file ProteusDriver.C.

References opts_.

{ return opts_; }

getProgramType()

jsoncons::string_view NEM::DRV::ProteusDriver::getProgramType ( ) const

overrideprivatevirtual

Implements NEM::DRV::NemDriver.

Definition at line 65 of file ProteusDriver.C.

References programType.

                                                        {
  return programType;
}

readJSON()

std::unique_ptr< NemDriver > NEM::DRV::NemDriver::readJSON ( const jsoncons::json &  inputjson )

staticinherited

Parameters

inputjson

json input with "Program Type" key

Returns

pointer to base NemDriver class

Definition at line 37 of file NemDriver.C.

Referenced by NEM::DRV::MeshGenDriver::MeshGenDriver().

                                                                          {
  return inputjson.as<std::unique_ptr<NemDriver>>();
}

setFiles()

void NEM::DRV::ProteusDriver::setFiles

(

Files

files

)

Definition at line 55 of file ProteusDriver.C.

References files_.

{ this->files_ = std::move(files); }

setOpts()

void NEM::DRV::ProteusDriver::setOpts

(

Opts

opts

)

Definition at line 59 of file ProteusDriver.C.

References opts_.

{ this->opts_ = std::move(opts); }

Member Data Documentation

files_

Files NEM::DRV::ProteusDriver::files_

private

Definition at line 99 of file ProteusDriver.H.

Referenced by execute(), getFiles(), and setFiles().

opts_

Opts NEM::DRV::ProteusDriver::opts_

private

Definition at line 100 of file ProteusDriver.H.

Referenced by getOpts(), and setOpts().

programType

constexpr const char* NEM::DRV::ProteusDriver::programType = "Proteus"

staticprivate

Definition at line 102 of file ProteusDriver.H.

Referenced by getProgramType().

---

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

• ProteusDriver.H
• ProteusDriver.C