A Topology model providing user visible topological names. More...

#include "CffInterface/CffLocationModel.hpp"

Public Member Functions
	CffLocationModel ()

	~CffLocationModel ()

void	getParts (PartIds &) const

bool	findPart (const std::string &, PartId &) const

void	clearTopology ()

void	createPart (Dimensionality, const std::string &, PartId &)

bool	getPartName (PartId, std::string &) const

bool	getPartDimensionality (PartId, Dimensionality &) const

bool	getPartBodies (PartId, BodyIds &) const

bool	getPartFaces (PartId, FaceIds &) const

bool	getPartFaceUses (PartId, FaceUseIds &) const

bool	getPartComposites (PartId, CompositeIds &) const

bool	findBody (PartId, const std::string &, BodyId &) const

bool	findFace (PartId, const std::string &, FaceId &) const

bool	findFaceUse (PartId, const std::string &, FaceUseId &) const

bool	findComposite (PartId, const std::string &, CompositeId &) const

bool	createBody (PartId, const std::string &, BodyId &)

bool	createFace (PartId, const std::string &, FaceId &)

bool	createComposite (PartId, const std::string &, CompositeId &)

bool	setPartName (PartId, const std::string &)

bool	deletePart (PartId)

bool	getBodyPart (BodyId, PartId &) const

bool	getBodyName (BodyId, std::string &) const

bool	getBodyBoundary (BodyId, FaceUseIds &) const

bool	getBodyZones (BodyId, MeshId, ZoneIds &) const

bool	setBodyZones (BodyId, MeshId, const ZoneIds &)

bool	setBodyName (BodyId, const std::string &)

bool	deleteBody (BodyId)

bool	getFacePart (FaceId, PartId &) const

bool	getFaceName (FaceId, std::string &) const

bool	getFaceZones (FaceId, MeshId, ZoneIds &) const

bool	getFaceSides (FaceId, FaceUseId &, FaceUseId &) const

bool	setFaceZones (FaceId, MeshId, const ZoneIds &)

bool	setFaceName (FaceId, const std::string &)

bool	deleteFace (FaceId)

bool	getFaceUsePart (FaceUseId, PartId &) const

bool	getFaceUseDefinition (FaceUseId, BodyId &, FaceId &, int &side) const

bool	getFaceUseName (FaceUseId, std::string &) const

bool	getFaceUseRelativeName (FaceUseId, std::string &) const

bool	getFaceUseZoneSides (FaceUseId, MeshId, ZoneSideIds &) const

bool	createFaceUse (BodyId, FaceId, int side, FaceUseId &)

bool	setFaceUseZoneSides (FaceUseId, MeshId, const ZoneSideIds &)

bool	setFaceUseName (FaceUseId, const std::string &)

bool	deleteFaceUse (FaceUseId)

bool	getCompositeComponents (CompositeId, BodyIds &, FaceIds &, FaceUseIds &, CompositeIds &) const

bool	resolveComposite (CompositeId, BodyIds &, FaceIds &, FaceUseIds &) const

bool	getCompositeName (CompositeId, std::string &) const

bool	setCompositeComponents (CompositeId, const BodyIds &, const FaceIds &, const FaceUseIds &, const CompositeIds &)

bool	setCompositeName (CompositeId, const std::string &)

bool	deleteComposite (CompositeId)

bool	resolveLocation (const std::vector< std::string > &locationNames, PartId partId, MeshId meshId, ZoneIds &cellZones, ZoneSideIds &faceZoneSides) const

bool	resolveLocation (const std::string &locationString, PartId partId, MeshId meshId, ZoneIds &cellZones, ZoneSideIds &faceZoneSides) const

std::string	state () const

void	reset (const std::string &state)

Detailed Description

A Topology model providing user visible topological names.

The CffLocationModel provides a set of functions that allow the user to examine the topological relationships between named locations such as named Bodies and named Faces Uses that bound them along with named Composite regions.

By querying the functions in the CffLocationModel it is possible to deduce how the topological names relate to the underlying mesh zones.

The :PhysicsDM defines Domains, Boundaries, Interfaces and SubDomains that are located at locations defined by one or more topological names that can be resolved to one or more mesh zones using this model.

Constructor & Destructor Documentation

◆ CffLocationModel()

ansys::CffLocationModel::CffLocationModel ( )

◆ ~CffLocationModel()

ansys::CffLocationModel::~CffLocationModel ( )

Member Function Documentation

◆ clearTopology()

void ansys::CffLocationModel::clearTopology ( )

◆ createBody()

bool ansys::CffLocationModel::createBody	(	PartId	partId,
		const std::string &	name,
		BodyId &	bodyId
	)

◆ createComposite()

bool ansys::CffLocationModel::createComposite	(	PartId	partId,
		const std::string &	name,
		CompositeId &	compositeId
	)

◆ createFace()

bool ansys::CffLocationModel::createFace	(	PartId	partId,
		const std::string &	name,
		FaceId &	faceId
	)

◆ createFaceUse()

bool ansys::CffLocationModel::createFaceUse	(	BodyId	bodyId,
		FaceId	faceId,
		int	side,
		FaceUseId &	faceUseId
	)

◆ createPart()

void ansys::CffLocationModel::createPart	(	Dimensionality	dimensionality,
		const std::string &	name,
		PartId &	partId
	)

◆ deleteBody()

bool ansys::CffLocationModel::deleteBody ( BodyId bodyId )

◆ deleteComposite()

bool ansys::CffLocationModel::deleteComposite ( CompositeId compositeId )

◆ deleteFace()

bool ansys::CffLocationModel::deleteFace ( FaceId faceId )

◆ deleteFaceUse()

bool ansys::CffLocationModel::deleteFaceUse ( FaceUseId faceUseId )

◆ deletePart()

bool ansys::CffLocationModel::deletePart ( PartId partId )

◆ findBody()

bool ansys::CffLocationModel::findBody	(	PartId	partId,
		const std::string &	name,
		BodyId &	bodyId
	)		const

◆ findComposite()

bool ansys::CffLocationModel::findComposite	(	PartId	partId,
		const std::string &	name,
		CompositeId &	compositeId
	)		const

◆ findFace()

bool ansys::CffLocationModel::findFace	(	PartId	partId,
		const std::string &	name,
		FaceId &	faceId
	)		const

◆ findFaceUse()

bool ansys::CffLocationModel::findFaceUse	(	PartId	partId,
		const std::string &	name,
		FaceUseId &	faceUseId
	)		const

◆ findPart()

bool ansys::CffLocationModel::findPart	(	const std::string &	name,
		PartId &	partId
	)		const

◆ getBodyBoundary()

bool ansys::CffLocationModel::getBodyBoundary	(	BodyId	bodyId,
		FaceUseIds &	faceUseIds
	)		const

◆ getBodyName()

bool ansys::CffLocationModel::getBodyName	(	BodyId	bodyId,
		std::string &	name
	)		const

◆ getBodyPart()

bool ansys::CffLocationModel::getBodyPart	(	BodyId	bodyId,
		PartId &	partId
	)		const

◆ getBodyZones()

bool ansys::CffLocationModel::getBodyZones	(	BodyId	bodyId,
		MeshId	meshId,
		ZoneIds &	zoneIds
	)		const

◆ getCompositeComponents()

bool ansys::CffLocationModel::getCompositeComponents	(	CompositeId	compositeId,
		BodyIds &	bodyIds,
		FaceIds &	faceIds,
		FaceUseIds &	faceUseIds,
		CompositeIds &	compositeIds
	)		const

◆ getCompositeName()

bool ansys::CffLocationModel::getCompositeName	(	CompositeId	compositeId,
		std::string &	name
	)		const

◆ getFaceName()

bool ansys::CffLocationModel::getFaceName	(	FaceId	faceId,
		std::string &	name
	)		const

◆ getFacePart()

bool ansys::CffLocationModel::getFacePart	(	FaceId	faceId,
		PartId &	partId
	)		const

◆ getFaceSides()

bool ansys::CffLocationModel::getFaceSides	(	FaceId	faceId,
		FaceUseId &	faceUse0Id,
		FaceUseId &	faceUse1Id
	)		const

◆ getFaceUseDefinition()

bool ansys::CffLocationModel::getFaceUseDefinition	(	FaceUseId	faceUseId,
		BodyId &	bodyId,
		FaceId &	faceId,
		int &	side
	)		const

◆ getFaceUseName()

bool ansys::CffLocationModel::getFaceUseName	(	FaceUseId	faceUseId,
		std::string &	name
	)		const

◆ getFaceUsePart()

bool ansys::CffLocationModel::getFaceUsePart	(	FaceUseId	faceUseId,
		PartId &	partId
	)		const

◆ getFaceUseRelativeName()

bool ansys::CffLocationModel::getFaceUseRelativeName	(	FaceUseId	faceUseId,
		std::string &	name
	)		const

◆ getFaceUseZoneSides()

bool ansys::CffLocationModel::getFaceUseZoneSides	(	FaceUseId	faceUseId,
		MeshId	meshId,
		ZoneSideIds &	zoneSideIds
	)		const

◆ getFaceZones()

bool ansys::CffLocationModel::getFaceZones	(	FaceId	faceId,
		MeshId	meshId,
		ZoneIds &	zoneIds
	)		const

◆ getPartBodies()

bool ansys::CffLocationModel::getPartBodies	(	PartId	partId,
		BodyIds &	bodyIds
	)		const

◆ getPartComposites()

bool ansys::CffLocationModel::getPartComposites	(	PartId	partId,
		CompositeIds &	compositeIds
	)		const

◆ getPartDimensionality()

bool ansys::CffLocationModel::getPartDimensionality	(	PartId	partId,
		Dimensionality &	dimensionality
	)		const

◆ getPartFaces()

bool ansys::CffLocationModel::getPartFaces	(	PartId	partId,
		FaceIds &	faceIds
	)		const

◆ getPartFaceUses()

bool ansys::CffLocationModel::getPartFaceUses	(	PartId	partId,
		FaceUseIds &	faceUseIds
	)		const

◆ getPartName()

bool ansys::CffLocationModel::getPartName	(	PartId	partId,
		std::string &	name
	)		const

◆ getParts()

void ansys::CffLocationModel::getParts ( PartIds & partIds ) const

◆ reset()

void ansys::CffLocationModel::reset ( const std::string & state )

◆ resolveComposite()

bool ansys::CffLocationModel::resolveComposite	(	CompositeId	compositeId,
		BodyIds &	bodyIds,
		FaceIds &	faceIds,
		FaceUseIds &	faceUseIds
	)		const

◆ resolveLocation() [1/2]

bool ansys::CffLocationModel::resolveLocation	(	const std::string &	locationString,
		PartId	partId,
		MeshId	meshId,
		ZoneIds &	cellZones,
		ZoneSideIds &	faceZoneSides
	)		const

◆ resolveLocation() [2/2]

bool ansys::CffLocationModel::resolveLocation	(	const std::vector< std::string > &	locationNames,
		PartId	partId,
		MeshId	meshId,
		ZoneIds &	cellZones,
		ZoneSideIds &	faceZoneSides
	)		const

◆ setBodyName()

bool ansys::CffLocationModel::setBodyName	(	BodyId	bodyId,
		const std::string &	name
	)

◆ setBodyZones()

bool ansys::CffLocationModel::setBodyZones	(	BodyId	bodyId,
		MeshId	meshId,
		const ZoneIds &	zoneIds
	)

◆ setCompositeComponents()

bool ansys::CffLocationModel::setCompositeComponents	(	CompositeId	compositeId,
		const BodyIds &	bodyIds,
		const FaceIds &	faceIds,
		const FaceUseIds &	faceUseIds,
		const CompositeIds &	compositeIds
	)

◆ setCompositeName()

bool ansys::CffLocationModel::setCompositeName	(	CompositeId	compositeId,
		const std::string &	name
	)

◆ setFaceName()

bool ansys::CffLocationModel::setFaceName	(	FaceId	faceId,
		const std::string &	name
	)

◆ setFaceUseName()

bool ansys::CffLocationModel::setFaceUseName	(	FaceUseId	faceUseId,
		const std::string &	name
	)

◆ setFaceUseZoneSides()

bool ansys::CffLocationModel::setFaceUseZoneSides	(	FaceUseId	faceUseId,
		MeshId	meshId,
		const ZoneSideIds &	zoneSideIds
	)

◆ setFaceZones()

bool ansys::CffLocationModel::setFaceZones	(	FaceId	faceId,
		MeshId	meshId,
		const ZoneIds &	zoneIds
	)

◆ setPartName()

bool ansys::CffLocationModel::setPartName	(	PartId	partId,
		const std::string &	name
	)

◆ state()

std::string ansys::CffLocationModel::state ( ) const

ansys::CffLocationModel Class Reference

Public Member Functions