CEPS: Unknown Class Reference

Detailed Description

A class used to defined an unknown of a PDE problem The unknown can be defined on a specific region, or can be 0D. If defined on a region, it can be localized either on cells or points of the mesh (point by default). Each unknown has an ID (int), and a name (str).

Definition at line 44 of file Unknown.hpp.

#include <Unknown.hpp>

Inheritance diagram for Unknown:

[legend]

Public Member Functions
	Unknown ()=delete
	Default constructor. More...

	Unknown (const CepsUnknownIndex &identifier, const CepsString &name=CepsString(CepsNoName), const CepsString &unit=CepsString(CepsNoUnit))
	Constructor by identifier, name, region attributes, unit. Location set on points. More...

	Unknown (const Unknown &that)
	Copy constructor. More...

Unknown &	operator= (const Unknown &that)
	Copy assignement. More...

CepsUnknownIndex	getIdentifier () const
	Get the identifier of the unknown. More...

const CepsString &	getName () const
	Get the name of the unknown. More...

void	setName (const CepsString &name)
	Get the name of the unknown. More...

const CepsString &	getUnit () const
	Get the unit of the unknown. More...

void	setUnit (const CepsString &unit)
	Set the unit of the unknown. More...

const CepsLocationFlag &	getLocation () const
	Get the data location of the unknown. More...

const CepsSet< Unknown * > &	getUnknownsInInteraction () const
	Get the set of unknowns with whom there are interactions. More...

CepsBool	isOnLocation (const CepsLocationFlag &flag) const
	Detect if the unknown is appliable on this location. More...

void	setLocation (const CepsLocationFlag &location)
	Set the data location of the unknown. More...

CepsBool	isSpatial () const
	Tells if unknown is defined on geometrical elements. More...

void	addUnknownInteraction (Unknown *u, CepsBool addReciprocal=true)
	Add an unknown this one interacts with. More...

CepsBool	interactsWith (Unknown *u) const
	Tells if unknowns interacts with another, true if self. More...

Public Member Functions inherited from ceps::HoldsAttributes
	HoldsAttributes (const CepsSet< CepsAttribute > &attributes)
	Constructor with any number of attributes. More...

	HoldsAttributes (const CepsVector< CepsAttribute > &attributes)
	Constructor with any number of attributes. More...

	HoldsAttributes (CepsAttribute *attributes, const CepsUInt &n)
	Constructor with any number of attributes. More...

	HoldsAttributes ()=default
	Default constructor. More...

	HoldsAttributes (const HoldsAttributes &)=default
	Assignement operator. More...

	HoldsAttributes (HoldsAttributes &&) noexcept=default
	Copy constructor. More...

virtual	~HoldsAttributes ()=default
	Destructor. More...

HoldsAttributes &	operator= (const HoldsAttributes &)=default
	Assignment operator. More...

HoldsAttributes &	operator= (HoldsAttributes &&) noexcept=default
	Assignment operator. More...

CepsUInt	getNumberOfAttributes () const
	Returns number of attributes of the entity. More...

CepsSet< CepsAttribute > &	getAttributes ()
	Returns the attributes of the entity. More...

const CepsSet< CepsAttribute > &	getAttributes () const
	Returns the attributes of the entity, const version. More...

void	setAttributes (const CepsVector< CepsAttribute > &attributes)
	Sets the attributes of the entity. More...

void	setAttributes (const CepsSet< CepsAttribute > &attributes)
	Sets the attributes of the entity. More...

void	setAttributes (const CepsAttribute *attributes, const CepsUInt &n)
	Sets the attributes of the entity. More...

template<class _It >
void	setAttributes (_It first, _It last)
	Sets the attributes of the entity. More...

void	addAttribute (const CepsAttribute &name)
	Adds an attribute to the entity. More...

void	addAttributes (const CepsVector< CepsAttribute > &attributes)
	Adds several attributes to the entity. More...

void	addAttributes (const CepsSet< CepsAttribute > &attributes)
	Adds several attributes to the entity. More...

void	addAttributes (const CepsAttribute *attributes, const CepsUInt &n)
	Adds several attributes to the entity. More...

template<class _It >
void	addAttributes (_It first, _It last)
	Adds several attributes to the entity. More...

void	removeAttribute (const CepsAttribute &name)
	Removes an attribute from the entity. More...

void	removeAttributes (const CepsSet< CepsAttribute > &attributes)
	Removes several attributes from the entity. More...

void	removeAttributes (const CepsVector< CepsAttribute > &attributes)
	Removes several attributes from the entity. More...

void	removeAttributes (const CepsAttribute *attributes, const CepsUInt &n)
	Removes several attributes from the entity. More...

template<class _It >
void	removeAttributes (_It first, _It last)
	Removes several attributes from the entity. More...

void	clearAttributes ()
	Removes all attributes from the entity. More...

CepsBool	hasAttribute (const CepsAttribute &name) const
	Tells if the entity has the attribute in argument. More...

CepsBool	hasAllAttributes (const CepsVector< CepsAttribute > &attributes) const
	Tells if the entity has all the attributes in argument. More...

CepsBool	hasAllAttributes (const CepsAttribute *attributes, const CepsUInt &n) const
	Tells if the entity has all the attributes in argument. More...

template<class _It >
CepsBool	hasAllAttributes (_It first, _It last) const
	Tells if the entity has all the attributes in argument. More...

CepsBool	hasOneOfAttributes (const CepsSet< CepsAttribute > &attributes) const
	Tells if the entity has one of the attributes in argument. More...

CepsBool	hasOneOfAttributes (const CepsVector< CepsAttribute > &attributes) const
	Tells if the entity has one of the attributes in argument. More...

CepsBool	hasOneOfAttributes (const CepsAttribute *attributes, const CepsUInt &n) const
	Tells if the entity has one of the attributes in argument. More...

template<class _It >
CepsBool	hasOneOfAttributes (_It first, _It last) const
	Tells if the entity has one of the attributes in argument. More...

CepsBool	hasUniversalAttribute () const
	Detect if the current entity has the attribute universal. More...

void	reset ()
	Equivalent to HoldsAttributes::clear() More...

Protected Attributes
CepsUnknownIndex	m_identifier
	Identifier. More...

CepsString	m_name
	Name of the unknown. More...

CepsString	m_unit
	Unit of the unknown. More...

CepsLocationFlag	m_location
	Unknown location. More...

CepsSet< Unknown * >	m_interactsWith
	Other unknowns in interaction. More...

Protected Attributes inherited from ceps::HoldsAttributes
CepsSet< CepsAttribute >	m_attributes
	The attributes held by the entity. More...

Constructor & Destructor Documentation

◆ Unknown() [1/3]

Unknown::Unknown ( )

delete

Default constructor.

◆ Unknown() [2/3]

Unknown::Unknown	(	const CepsUnknownIndex &	identifier,
		const CepsString &	name = `CepsString(CepsNoName)`,
		const CepsString &	unit = `CepsString(CepsNoUnit)`
	)

explicit

Constructor by identifier, name, region attributes, unit. Location set on points.

Definition at line 32 of file Unknown.cpp.

◆ Unknown() [3/3]

Unknown::Unknown ( const Unknown & that )

Copy constructor.

Definition at line 45 of file Unknown.cpp.

Member Function Documentation

◆ addUnknownInteraction()

void Unknown::addUnknownInteraction	(	Unknown *	u,
		CepsBool	addReciprocal = `true`
	)

Add an unknown this one interacts with.

Definition at line 126 of file Unknown.cpp.

◆ getIdentifier()

CepsUnknownIndex Unknown::getIdentifier ( ) const

Get the identifier of the unknown.

Definition at line 82 of file Unknown.cpp.

◆ getLocation()

const CepsLocationFlag & Unknown::getLocation ( ) const

Get the data location of the unknown.

Definition at line 101 of file Unknown.cpp.

◆ getName()

const CepsString & Unknown::getName ( ) const

Get the name of the unknown.

Definition at line 69 of file Unknown.cpp.

◆ getUnit()

const CepsString & Unknown::getUnit ( ) const

Get the unit of the unknown.

Definition at line 88 of file Unknown.cpp.

◆ getUnknownsInInteraction()

const CepsSet< Unknown * > & Unknown::getUnknownsInInteraction ( ) const

Get the set of unknowns with whom there are interactions.

Definition at line 143 of file Unknown.cpp.

◆ interactsWith()

CepsBool Unknown::interactsWith ( Unknown * u ) const

Tells if unknowns interacts with another, true if self.

Definition at line 137 of file Unknown.cpp.

◆ isOnLocation()

CepsBool Unknown::isOnLocation ( const CepsLocationFlag & flag ) const

Detect if the unknown is appliable on this location.

Definition at line 107 of file Unknown.cpp.

◆ isSpatial()

CepsBool Unknown::isSpatial ( ) const

Tells if unknown is defined on geometrical elements.

Definition at line 120 of file Unknown.cpp.

◆ operator=()

Unknown & Unknown::operator= ( const Unknown & that )

Copy assignement.

Definition at line 55 of file Unknown.cpp.

◆ setLocation()

void Unknown::setLocation ( const CepsLocationFlag & location )

Set the data location of the unknown.

Definition at line 113 of file Unknown.cpp.

◆ setName()

void Unknown::setName ( const CepsString & name )

Get the name of the unknown.

Definition at line 75 of file Unknown.cpp.

◆ setUnit()

void Unknown::setUnit ( const CepsString & unit )

Set the unit of the unknown.

Definition at line 94 of file Unknown.cpp.

Field Documentation

◆ m_identifier

CepsUnknownIndex Unknown::m_identifier

protected

Identifier.

Definition at line 116 of file Unknown.hpp.

◆ m_interactsWith

CepsSet<Unknown*> Unknown::m_interactsWith

protected

Other unknowns in interaction.

Definition at line 120 of file Unknown.hpp.

◆ m_location

CepsLocationFlag Unknown::m_location

protected

Unknown location.

Definition at line 119 of file Unknown.hpp.

◆ m_name

CepsString Unknown::m_name

protected

Name of the unknown.

Definition at line 117 of file Unknown.hpp.

◆ m_unit

CepsString Unknown::m_unit

protected

Unit of the unknown.

Definition at line 118 of file Unknown.hpp.

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

/builds/xxjFYZX3/0/carmen/ceps/src/pde/common/Unknown.hpp
/builds/xxjFYZX3/0/carmen/ceps/src/pde/common/Unknown.cpp

Detailed Description

Public Member Functions

Protected Attributes

Constructor & Destructor Documentation

◆ Unknown() [1/3]

◆ Unknown() [2/3]

◆ Unknown() [3/3]

Member Function Documentation

◆ addUnknownInteraction()

◆ getIdentifier()

◆ getLocation()

◆ getName()

◆ getUnit()

◆ getUnknownsInInteraction()

◆ interactsWith()

◆ isOnLocation()

◆ isSpatial()

◆ operator=()

◆ setLocation()

◆ setName()

◆ setUnit()

Field Documentation

◆ m_identifier

◆ m_interactsWith

◆ m_location

◆ m_name

◆ m_unit