This mathematical function provides the transmission signal attenuation for any given space, time, and frequency coordinates. More...

#include <PowerFunctions.h>

Inheritance diagram for inet::physicallayer::SpaceDependentAttenuationFunction:

Public Member Functions
	SpaceDependentAttenuationFunction (const Ptr< const IFunction< double, Domain< Quaternion >>> &transmitterAntennaGainFunction, const Ptr< const IFunction< double, Domain< mps, m, Hz >>> &pathLossFunction, const Ptr< const IFunction< double, Domain< m, m, m, m, m, m, Hz >>> &obstacleLossFunction, const Point< m, m, m > startPosition, const Quaternion &startOrientation, const mps propagationSpeed, Hz frequency)

virtual double	getValue (const Point< m, m, m, simsec, Hz > &p) const override

virtual void	partition (const Interval< m, m, m, simsec, Hz > &i, const std::function< void(const Interval< m, m, m, simsec, Hz > &, const IFunction< double, Domain< m, m, m, simsec, Hz >> *)> f) const override

virtual bool	isFinite (const Interval< m, m, m, simsec, Hz > &i) const override

virtual void	printStructure (std::ostream &os, int level=0) const override
	Prints the internal data structure of this function in a human readable form to the provided stream. More...

Public Member Functions inherited from inet::math::FunctionBase< double, Domain< m, m, m, simsec, Hz > >
virtual void	partition (const typename Domain< m, m, m, simsec, Hz > ::I &i, const std::function< void(const typename Domain< m, m, m, simsec, Hz > ::I &, const IFunction< double, Domain< m, m, m, simsec, Hz > > *)> callback) const override
	Subdivides the provided domain and calls back f with the subdomains and the corresponding potentially simpler domain limited functions. More...

virtual Interval< double >	getRange () const override
	Returns the valid range of the function as an interval. More...

virtual Interval< double >	getRange (const typename Domain< m, m, m, simsec, Hz > ::I &i) const override
	Returns the valid range of the function as an interval for the given domain. More...

virtual Domain< m, m, m, simsec, Hz > ::I	getDomain () const override
	Returns the valid domain of the function as an interval. More...

virtual bool	isFinite () const override
	Returns true if the function value is finite in the whole domain. More...

virtual bool	isFinite (const typename Domain< m, m, m, simsec, Hz > ::I &i) const override
	Returns true if the function value is finite in the given domain. More...

virtual bool	isNonZero () const override
	Returns true if the function value is non-zero in the whole domain. More...

virtual bool	isNonZero (const typename Domain< m, m, m, simsec, Hz > ::I &i) const override
	Returns true if the function value is non-zero in the given domain. More...

virtual double	getMin () const override
	Returns the minimum value for the whole domain. More...

virtual double	getMin (const typename Domain< m, m, m, simsec, Hz > ::I &i) const override
	Returns the minimum value for the given domain. More...

virtual double	getMax () const override
	Returns the maximum value for the whole domain. More...

virtual double	getMax (const typename Domain< m, m, m, simsec, Hz > ::I &i) const override
	Returns the maximum value for the given domain. More...

virtual double	getMean () const override
	Returns the mean value for the whole domain. More...

virtual double	getMean (const typename Domain< m, m, m, simsec, Hz > ::I &i) const override
	Returns the mean value for the given domain. More...

virtual double	getIntegral () const override
	Returns the integral value for the whole domain. More...

virtual double	getIntegral (const typename Domain< m, m, m, simsec, Hz > ::I &i) const override
	Returns the integral value for the given domain. More...

virtual const Ptr< const IFunction< double, Domain< m, m, m, simsec, Hz > > >	add (const Ptr< const IFunction< double, Domain< m, m, m, simsec, Hz > >> &o) const override
	Adds the provided function to this function. More...

virtual const Ptr< const IFunction< double, Domain< m, m, m, simsec, Hz > > >	subtract (const Ptr< const IFunction< double, Domain< m, m, m, simsec, Hz > >> &o) const override
	Substracts the provided function from this function. More...

virtual const Ptr< const IFunction< double, Domain< m, m, m, simsec, Hz > > >	multiply (const Ptr< const IFunction< double, Domain< m, m, m, simsec, Hz > >> &o) const override
	Multiplies the provided function with this function. More...

virtual const Ptr< const IFunction< double, Domain< m, m, m, simsec, Hz > > >	divide (const Ptr< const IFunction< double, Domain< m, m, m, simsec, Hz > >> &o) const override
	Divides this function with the provided function. More...

virtual std::ostream &	printOn (std::ostream &os) const override

virtual void	print (std::ostream &os, int level=0) const override
	Prints this function in human readable form to the provided stream for the whole domain. More...

virtual void	print (std::ostream &os, const typename Domain< m, m, m, simsec, Hz > ::I &i, int level=0) const override
	Prints this function in a human readable form to the provided stream for the given domain. More...

virtual void	printPartitioning (std::ostream &os, const typename Domain< m, m, m, simsec, Hz > ::I &i, int level) const override
	Prints the partitioning of this function in a human readable form to the provided stream for the given domain. More...

virtual void	printPartition (std::ostream &os, const typename Domain< m, m, m, simsec, Hz > ::I &i, int level=0) const override
	Prints a single partition of this function in a human readable form to the provided stream for the given domain. More...

Public Member Functions inherited from inet::math::IFunction< double, Domain< m, m, m, simsec, Hz > >
virtual	~IFunction ()

virtual double	getValue (const typename Domain< m, m, m, simsec, Hz > ::P &p) const=0
	Returns the value of the function at the given point. More...

Protected Attributes
const Ptr< const IFunction< double, Domain< Quaternion > > >	transmitterAntennaGainFunction

const Ptr< const IFunction< double, Domain< mps, m, Hz > > >	pathLossFunction

const Ptr< const IFunction< double, Domain< m, m, m, m, m, m, Hz > > >	obstacleLossFunction

const Point< m, m, m >	startPosition

const Quaternion	startOrientation

const mps	propagationSpeed

const Hz	frequency

Detailed Description

This mathematical function provides the transmission signal attenuation for any given space, time, and frequency coordinates.

The function value is only dependent on the space coordinates. This function assumes the transmitter and is stationary for the duration of the transmission. The function value is not frequency and time dependent but having the frequency and time dimensions in this definition simplifies further computations.

Constructor & Destructor Documentation

◆ SpaceDependentAttenuationFunction()

inet::physicallayer::SpaceDependentAttenuationFunction::SpaceDependentAttenuationFunction	(	const Ptr< const IFunction< double, Domain< Quaternion >>> &	transmitterAntennaGainFunction,
		const Ptr< const IFunction< double, Domain< mps, m, Hz >>> &	pathLossFunction,
		const Ptr< const IFunction< double, Domain< m, m, m, m, m, m, Hz >>> &	obstacleLossFunction,
		const Point< m, m, m >	startPosition,
		const Quaternion &	startOrientation,
		const mps	propagationSpeed,
		Hz	frequency
	)

inline

168 :

169 transmitterAntennaGainFunction(transmitterAntennaGainFunction), pathLossFunction(pathLossFunction), obstacleLossFunction(obstacleLossFunction), startPosition(startPosition), startOrientation(startOrientation), propagationSpeed(propagationSpeed), frequency(frequency) {}

Member Function Documentation

◆ getValue()

virtual double inet::physicallayer::SpaceDependentAttenuationFunction::getValue ( const Point< m, m, m, simsec, Hz > & p ) const

inlineoverridevirtual

                                                                                 {
         m x = std::get<0>(p);
         m y = std::get<1>(p);
         m z = std::get<2>(p);
         m startX = std::get<0>(startPosition);
         m startY = std::get<1>(startPosition);
         m startZ = std::get<2>(startPosition);
         m dx = x - startX;
         m dy = y - startY;
         m dz = z - startZ;
         m distance = m(sqrt(dx * dx + dy * dy + dz * dz));
         auto direction = Quaternion::rotationFromTo(Coord::X_AXIS, Coord(dx.get(), dy.get(), dz.get()));
         auto antennaLocalDirection = startOrientation.inverse() * direction;
         double transmitterAntennaGain = distance == m(0) || transmitterAntennaGainFunction == nullptr ? 1 : transmitterAntennaGainFunction->getValue(Point<Quaternion>(antennaLocalDirection));
         double pathLoss = pathLossFunction->getValue(Point<mps, m, Hz>(propagationSpeed, distance, frequency));
         double obstacleLoss = obstacleLossFunction != nullptr ? obstacleLossFunction->getValue(Point<m, m, m, m, m, m, Hz>(startX, startY, startZ, x, y, z, frequency)) : 1;
         double gain = transmitterAntennaGain * pathLoss * obstacleLoss;
         if (gain > 1.0) {
             EV_STATICCONTEXT;
             EV_WARN << "Signal power attenuation is zero.\n";
             gain = 1.0;
         }
         return gain;
     }

◆ isFinite()

virtual bool inet::physicallayer::SpaceDependentAttenuationFunction::isFinite ( const Interval< m, m, m, simsec, Hz > & i ) const

inlineoverridevirtual

210 { return true; }

◆ partition()

virtual void inet::physicallayer::SpaceDependentAttenuationFunction::partition	(	const Interval< m, m, m, simsec, Hz > &	i,
		const std::function< void(const Interval< m, m, m, simsec, Hz > &, const IFunction< double, Domain< m, m, m, simsec, Hz >> *)>	f
	)		const

inlineoverridevirtual

                                                                                                                                                                                                            {
         const auto& lower = i.getLower();
         const auto& upper = i.getUpper();
         if ((i.getFixed() & 0b11100) == 0b11100) {
             auto lowerValue = getValue(lower);
             auto upperValue = getValue(upper);
             ASSERT(lowerValue == upperValue);
             ConstantFunction<double, Domain<m, m, m, simsec, Hz>> g(lowerValue);
             f(i, &g);
         }
         else
             FunctionBase::partition(i, f);
     }

◆ printStructure()

virtual void inet::physicallayer::SpaceDependentAttenuationFunction::printStructure	(	std::ostream &	os,
		int	level = `0`
	)		const

inlineoverridevirtual

Prints the internal data structure of this function in a human readable form to the provided stream.

Reimplemented from inet::math::FunctionBase< double, Domain< m, m, m, simsec, Hz > >.

                                                                               {
         os << "(SpaceDependentAttenuation\n" << std::string(level + 2, ' ');
         if (transmitterAntennaGainFunction != nullptr) {
             transmitterAntennaGainFunction->printStructure(os, level + 2);
             os << "\n" << std::string(level + 2, ' ');
         }
         pathLossFunction->printStructure(os, level + 2);
         os << "\n" << std::string(level + 2, ' ');
         obstacleLossFunction->printStructure(os, level + 2);
         os << ")";
     }

Member Data Documentation

◆ frequency

const Hz inet::physicallayer::SpaceDependentAttenuationFunction::frequency

protected

◆ obstacleLossFunction

const Ptr<const IFunction<double, Domain<m, m, m, m, m, m, Hz> > > inet::physicallayer::SpaceDependentAttenuationFunction::obstacleLossFunction

protected

◆ pathLossFunction

const Ptr<const IFunction<double, Domain<mps, m, Hz> > > inet::physicallayer::SpaceDependentAttenuationFunction::pathLossFunction

protected

◆ propagationSpeed

const mps inet::physicallayer::SpaceDependentAttenuationFunction::propagationSpeed

protected

◆ startOrientation

const Quaternion inet::physicallayer::SpaceDependentAttenuationFunction::startOrientation

protected

◆ startPosition

const Point<m, m, m> inet::physicallayer::SpaceDependentAttenuationFunction::startPosition

protected

◆ transmitterAntennaGainFunction

const Ptr<const IFunction<double, Domain<Quaternion> > > inet::physicallayer::SpaceDependentAttenuationFunction::transmitterAntennaGainFunction

protected

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

PowerFunctions.h

Public Member Functions

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

◆ SpaceDependentAttenuationFunction()

Member Function Documentation

◆ getValue()

◆ isFinite()

◆ partition()

◆ printStructure()

Member Data Documentation

◆ frequency

◆ obstacleLossFunction

◆ pathLossFunction

◆ propagationSpeed

◆ startOrientation

◆ startPosition

◆ transmitterAntennaGainFunction