Opm::ECLUnits::Convert::PhysicalQuantity Class Reference

#include <ECLPropertyUnitConversion.hpp>

Inheritance diagram for Opm::ECLUnits::Convert::PhysicalQuantity:

Public Member Functions
	PhysicalQuantity ()
	Default constructor. More...
virtual	~PhysicalQuantity ()
	Destructor. More...
	PhysicalQuantity (const PhysicalQuantity &rhs)
	PhysicalQuantity (PhysicalQuantity &&rhs)
PhysicalQuantity &	operator= (const PhysicalQuantity &rhs)
PhysicalQuantity &	operator= (PhysicalQuantity &&rhs)
PhysicalQuantity &	from (const UnitSystem &usys)
PhysicalQuantity &	to (const UnitSystem &usys)
virtual void	appliedTo (std::vector< double > &x) const =0

Protected Member Functions
const UnitSystem *	from () const
const UnitSystem *	to () const

Detailed Description

Representation of a physical quantity

Base class. Resource management and operations common to all particular/specific physical quantities.

Constructor & Destructor Documentation

PhysicalQuantity() [1/3]

Opm::ECLUnits::Convert::PhysicalQuantity::PhysicalQuantity

(

)

Default constructor.

~PhysicalQuantity()

virtual Opm::ECLUnits::Convert::PhysicalQuantity::~PhysicalQuantity ( )

virtual

Destructor.

PhysicalQuantity() [2/3]

Opm::ECLUnits::Convert::PhysicalQuantity::PhysicalQuantity

(

const PhysicalQuantity &

rhs

)

Copy constructor.

Parameters

[in]

rhs

Existing physical quantity.

PhysicalQuantity() [3/3]

Opm::ECLUnits::Convert::PhysicalQuantity::PhysicalQuantity

(

PhysicalQuantity &&

rhs

)

Move constructor.

Subsumes the implementation of an existing Physical Quantity.

Parameters

[in]

rhs

Existing physical quantity. Does not have a valid implementation when the constructor completes.

Member Function Documentation

appliedTo()

virtual void Opm::ECLUnits::Convert::PhysicalQuantity::appliedTo ( std::vector< double > &  x ) const

pure virtual

Convert a physical quantity from its input unit of measure to its output unit of measure.

Must be overridden in derived classes.

Parameters

[in,out]

x

On input, a sequence of values of a physical quantities assumed to be defined in the input unit specified through from(usys) . On output, the same seqeuence of values converted to the output unit of measure specified through to(usys) .

Implemented in Opm::ECLUnits::Convert::GasFVF, Opm::ECLUnits::Convert::OilFVF, Opm::ECLUnits::Convert::Viscosity, Opm::ECLUnits::Convert::Pressure, Opm::ECLUnits::Convert::DissolvedGasOilRatio, and Opm::ECLUnits::Convert::VaporisedOilGasRatio.

from() [1/2]

const UnitSystem * Opm::ECLUnits::Convert::PhysicalQuantity::from ( ) const

protected

Retrieve input unit system.

Exists for the benefit of derived classes.

Returns

Input unit system. Null if not specified by caller.

from() [2/2]

PhysicalQuantity & Opm::ECLUnits::Convert::PhysicalQuantity::from

(

const UnitSystem &

usys

)

Specify collection of units of measure of the inputs.

Parameters

[in]

usys

Collection of units of measure of inputs.

Returns

*this 

.

operator=() [1/2]

PhysicalQuantity & Opm::ECLUnits::Convert::PhysicalQuantity::operator=

(

const PhysicalQuantity &

rhs

)

Assignment operator

Parameters

[in]

rhs

Existing Physical Quantity.

Returns

*this 

.

operator=() [2/2]

PhysicalQuantity & Opm::ECLUnits::Convert::PhysicalQuantity::operator=

(

PhysicalQuantity &&

rhs

)

Move assignment operator.

Subsumes the implementation of an existing object.

Parameters

[in]

rhs

Existing Physical Quantity. Does not have a valid implementation when the assignment completes.

Returns

*this 

.

to() [1/2]

const UnitSystem * Opm::ECLUnits::Convert::PhysicalQuantity::to ( ) const

protected

Retrieve output unit system.

Exists for the benefit of derived classes.

Returns

Output unit system. Null if not specified by caller.

to() [2/2]

PhysicalQuantity & Opm::ECLUnits::Convert::PhysicalQuantity::to

(

const UnitSystem &

usys

)

Specify collection of units of measure of the output.

Parameters

[in]

usys

Collection of units of measure of outputs.

Returns

*this 

.

---

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

• ECLPropertyUnitConversion.hpp