BLConductanceModel Class Reference

Boundary-layer conductance model class. More...

#include <BoundaryLayerConductanceModel.h>

Public Member Functions
	BLConductanceModel (helios::Context *context)
	Constructor.
void	enableMessages ()
	Enable standard output from this plug-in (default)
void	disableMessages ()
	Disable standard output from this plug-in.
void	setBoundaryLayerModel (const char *gH_model)
	Set the boundary-layer conductance model to be used for all primitives in the Context.
void	setBoundaryLayerModel (uint UUID, const char *gH_model)
	Set the boundary-layer conductance model to be used for a set of primitives.
void	setBoundaryLayerModel (const std::vector< uint > &UUIDs, const char *gH_model)
	Set the boundary-layer conductance model to be used for a set of primitives.
void	run ()
	Run boundary-layer conductance calculations for all primitives in the Context.
void	run (const std::vector< uint > &UUIDs)
	Run boundary-layer conductance calculations for a subset of primitives in the Context based on a vector of UUIDs.

Static Public Member Functions
static int	selfTest (int argc=0, char **argv=nullptr)
	Self-test.

Detailed Description

Boundary-layer conductance model class.

This model computes boundary-layer conductance values for a number of objects

Definition at line 23 of file BoundaryLayerConductanceModel.h.

Constructor & Destructor Documentation

BLConductanceModel()

BLConductanceModel::BLConductanceModel ( helios::Context *  context )

explicit

Constructor.

Parameters

[in]

context

Pointer to the Helios context

Definition at line 20 of file BoundaryLayerConductanceModel.cpp.

Member Function Documentation

disableMessages()

void BLConductanceModel::disableMessages

(

)

Disable standard output from this plug-in.

Definition at line 38 of file BoundaryLayerConductanceModel.cpp.

enableMessages()

void BLConductanceModel::enableMessages

(

)

Enable standard output from this plug-in (default)

Definition at line 34 of file BoundaryLayerConductanceModel.cpp.

run() [1/2]

void BLConductanceModel::run

(

)

Run boundary-layer conductance calculations for all primitives in the Context.

Definition at line 74 of file BoundaryLayerConductanceModel.cpp.

run() [2/2]

void BLConductanceModel::run

(

const std::vector< uint > &

UUIDs

)

Run boundary-layer conductance calculations for a subset of primitives in the Context based on a vector of UUIDs.

Definition at line 79 of file BoundaryLayerConductanceModel.cpp.

selfTest()

int BLConductanceModel::selfTest ( int  argc = 0, char **  argv = nullptr  )

static

Self-test.

Returns

0 if test was successful, 1 if test failed.

Definition at line 227 of file selfTest.cpp.

setBoundaryLayerModel() [1/3]

void BLConductanceModel::setBoundaryLayerModel

(

const char *

gH_model

)

Set the boundary-layer conductance model to be used for all primitives in the Context.

Parameters

[in]

gH_model

String corresponding to model to be run. One of "Pohlhausen", "InclinedPlate", "Sphere", or "Ground".

Definition at line 42 of file BoundaryLayerConductanceModel.cpp.

setBoundaryLayerModel() [2/3]

void BLConductanceModel::setBoundaryLayerModel	(	const std::vector< uint > &	UUIDs,
		const char *	gH_model
	)

Set the boundary-layer conductance model to be used for a set of primitives.

Parameters

[in]	UUIDs	Unique universal identifiers (UUIDs) for primitives the conductance model should be used.
[in]	gH_model	String corresponding to model to be run. One of "Pohlhausen", "InclinedPlate", "Sphere", or "Ground".

Definition at line 52 of file BoundaryLayerConductanceModel.cpp.

setBoundaryLayerModel() [3/3]

void BLConductanceModel::setBoundaryLayerModel	(	uint	UUID,
		const char *	gH_model
	)

Set the boundary-layer conductance model to be used for a set of primitives.

Parameters

[in]	UUID	Unique universal identifier (UUID) for primitive the conductance model should be used.
[in]	gH_model	String corresponding to model to be run. One of "Pohlhausen", "InclinedPlate", "Sphere", or "Ground".

Definition at line 47 of file BoundaryLayerConductanceModel.cpp.

---

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

• plugins/boundarylayerconductance/include/BoundaryLayerConductanceModel.h
• plugins/boundarylayerconductance/src/BoundaryLayerConductanceModel.cpp
• plugins/boundarylayerconductance/tests/selfTest.cpp