viewFactorModel Class Reference

A base class for viewFactor models. More...

Inheritance diagram for viewFactorModel:

Collaboration diagram for viewFactorModel:

Public Member Functions
	TypeName ("viewFactorModel")
	Runtime type information. More...
	declareRunTimeSelectionTable (autoPtr, viewFactorModel, mesh,(const fvMesh &mesh, const dictionary &dict),(mesh, dict))
	Selection table. More...
	viewFactorModel (const viewFactorModel &)=delete
	No copy construct. More...
void	operator= (const viewFactorModel &)=delete
	No copy assignment. More...
	viewFactorModel (const fvMesh &mesh, const dictionary &dict)
	Constructor. More...
virtual	~viewFactorModel ()
	Destructor. More...
virtual void	calculate ()
	Calculate the view factors. More...

Static Public Member Functions
static autoPtr< viewFactorModel >	New (const fvMesh &mesh, const dictionary &dict)
	Selector. More...

Protected Member Functions
virtual scalarListList	calculate (const labelListList &visibleFaceFaces, const pointField &compactCoarseCf, const vectorField &compactCoarseSf, const List< List< vector >> &compactFineSf, const List< List< point >> &compactFineCf, const DynamicList< List< point >> &compactPoints, const DynamicList< label > &compactPatchId) const =0
	Calculate the view factors using run-time selectable model. More...

Static Protected Member Functions
static void	writeRays (const fileName &fName, const pointField &compactCf, const labelListList &visibleFaceFaces)
	Write ray geometry to file. More...

Protected Attributes
const fvMesh &	mesh_
	Reference to the mesh database. More...
autoPtr< raySearchEngine >	searchEnginePtr_
	Run-time selectable ray search engine. More...
bool	writeViewFactors_
	Flag to write the view factor field. More...
bool	writeRays_
	Flag to write the ray geometry. More...

Detailed Description

A base class for viewFactor models.

Usage

Minimal example in <constant>/viewFactorsDict:

// Mandatory entries
writeViewFactors    <bool>;

// Optional entries
writeRays           <bool>;

where the entries mean:

Property	Description	Type	Reqd	Deflt
writeViewFactors	Flag to write the view factor field	bool	yes	-
writeRays	Flag to write the ray geometry	bool	no	false

Source files

• viewFactorModel.H
• viewFactorModel.C
• viewFactorModelNew.C

Definition at line 99 of file viewFactorModel.H.

Constructor & Destructor Documentation

viewFactorModel() [1/2]

viewFactorModel ( const viewFactorModel &  )

delete

No copy construct.

viewFactorModel() [2/2]

viewFactorModel	(	const fvMesh &	mesh,
		const dictionary &	dict
	)

Constructor.

~viewFactorModel()

virtual ~viewFactorModel ( )

virtual

Destructor.

Member Function Documentation

writeRays()

static void writeRays ( const fileName &  fName, const pointField &  compactCf, const labelListList &  visibleFaceFaces  )

staticprotected

Write ray geometry to file.

calculate() [1/2]

virtual scalarListList calculate ( const labelListList &  visibleFaceFaces, const pointField &  compactCoarseCf, const vectorField &  compactCoarseSf, const List< List< vector >> &  compactFineSf, const List< List< point >> &  compactFineCf, const DynamicList< List< point >> &  compactPoints, const DynamicList< label > &  compactPatchId  ) const

protectedpure virtual

Calculate the view factors using run-time selectable model.

Implemented in viewFactor2LI, viewFactorHottel, and viewFactor2AI.

TypeName()

TypeName

(

"viewFactorModel"

)

Runtime type information.

declareRunTimeSelectionTable()

declareRunTimeSelectionTable	(	autoPtr	,
		viewFactorModel	,
		mesh	,
		(const fvMesh &mesh, const dictionary &dict)	,
		(mesh, dict)
	)

Selection table.

New()

static autoPtr<viewFactorModel> New ( const fvMesh &  mesh, const dictionary &  dict  )

static

Selector.

operator=()

void operator= ( const viewFactorModel &  )

delete

No copy assignment.

calculate() [2/2]

virtual void calculate ( )

virtual

Calculate the view factors.

Member Data Documentation

mesh_

const fvMesh& mesh_

protected

Reference to the mesh database.

Definition at line 108 of file viewFactorModel.H.

searchEnginePtr_

autoPtr<raySearchEngine> searchEnginePtr_

protected

Run-time selectable ray search engine.

Definition at line 113 of file viewFactorModel.H.

writeViewFactors_

bool writeViewFactors_

protected

Flag to write the view factor field.

Definition at line 118 of file viewFactorModel.H.

writeRays_

bool writeRays_

protected

Flag to write the ray geometry.

Definition at line 123 of file viewFactorModel.H.

---

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

• applications/utilities/preProcessing/createViewFactors/viewFactorModels/viewFactorModel/viewFactorModel/viewFactorModel.H