unitsnet-js
Version:
A better way to hold unit variables and easily convert to the destination unit
347 lines (346 loc) • 17.1 kB
JavaScript
"use strict";
Object.defineProperty(exports, "__esModule", { value: true });
exports.PorousMediumPermeability = exports.PorousMediumPermeabilityUnits = void 0;
const base_unit_1 = require("../base-unit");
/** PorousMediumPermeabilityUnits enumeration */
var PorousMediumPermeabilityUnits;
(function (PorousMediumPermeabilityUnits) {
/** The darcy (or darcy unit) and millidarcy (md or mD) are units of permeability, named after Henry Darcy. They are not SI units, but they are widely used in petroleum engineering and geology. */
PorousMediumPermeabilityUnits["Darcys"] = "Darcy";
/** */
PorousMediumPermeabilityUnits["SquareMeters"] = "SquareMeter";
/** */
PorousMediumPermeabilityUnits["SquareCentimeters"] = "SquareCentimeter";
/** */
PorousMediumPermeabilityUnits["Microdarcys"] = "Microdarcy";
/** */
PorousMediumPermeabilityUnits["Millidarcys"] = "Millidarcy";
})(PorousMediumPermeabilityUnits = exports.PorousMediumPermeabilityUnits || (exports.PorousMediumPermeabilityUnits = {}));
/** In fluid mechanics, permeability is the measure of the ability of a porous material to allow fluids to pass through it. */
class PorousMediumPermeability extends base_unit_1.BaseUnit {
/**
* Create a new PorousMediumPermeability.
* @param value The value.
* @param fromUnit The ‘PorousMediumPermeability’ unit to create from.
* The default unit is SquareMeters
*/
constructor(value, fromUnit = PorousMediumPermeabilityUnits.SquareMeters) {
super();
this.darcysLazy = null;
this.squaremetersLazy = null;
this.squarecentimetersLazy = null;
this.microdarcysLazy = null;
this.millidarcysLazy = null;
if (value === undefined || value === null || Number.isNaN(value)) {
throw new TypeError('invalid unit value ‘' + value + '’');
}
this.value = this.convertToBase(value, fromUnit);
}
/**
* The base value of PorousMediumPermeability is SquareMeters.
* This accessor used when needs a value for calculations and it's better to use directly the base value
*/
get BaseValue() {
return this.value;
}
/** Gets the default unit used when creating instances of the unit or its DTO */
get baseUnit() {
return PorousMediumPermeabilityUnits.SquareMeters;
}
/** The darcy (or darcy unit) and millidarcy (md or mD) are units of permeability, named after Henry Darcy. They are not SI units, but they are widely used in petroleum engineering and geology. */
get Darcys() {
if (this.darcysLazy !== null) {
return this.darcysLazy;
}
return this.darcysLazy = this.convertFromBase(PorousMediumPermeabilityUnits.Darcys);
}
/** */
get SquareMeters() {
if (this.squaremetersLazy !== null) {
return this.squaremetersLazy;
}
return this.squaremetersLazy = this.convertFromBase(PorousMediumPermeabilityUnits.SquareMeters);
}
/** */
get SquareCentimeters() {
if (this.squarecentimetersLazy !== null) {
return this.squarecentimetersLazy;
}
return this.squarecentimetersLazy = this.convertFromBase(PorousMediumPermeabilityUnits.SquareCentimeters);
}
/** */
get Microdarcys() {
if (this.microdarcysLazy !== null) {
return this.microdarcysLazy;
}
return this.microdarcysLazy = this.convertFromBase(PorousMediumPermeabilityUnits.Microdarcys);
}
/** */
get Millidarcys() {
if (this.millidarcysLazy !== null) {
return this.millidarcysLazy;
}
return this.millidarcysLazy = this.convertFromBase(PorousMediumPermeabilityUnits.Millidarcys);
}
/**
* Create a new PorousMediumPermeability instance from a Darcys
* The darcy (or darcy unit) and millidarcy (md or mD) are units of permeability, named after Henry Darcy. They are not SI units, but they are widely used in petroleum engineering and geology.
* @param value The unit as Darcys to create a new PorousMediumPermeability from.
* @returns The new PorousMediumPermeability instance.
*/
static FromDarcys(value) {
return new PorousMediumPermeability(value, PorousMediumPermeabilityUnits.Darcys);
}
/**
* Create a new PorousMediumPermeability instance from a SquareMeters
*
* @param value The unit as SquareMeters to create a new PorousMediumPermeability from.
* @returns The new PorousMediumPermeability instance.
*/
static FromSquareMeters(value) {
return new PorousMediumPermeability(value, PorousMediumPermeabilityUnits.SquareMeters);
}
/**
* Create a new PorousMediumPermeability instance from a SquareCentimeters
*
* @param value The unit as SquareCentimeters to create a new PorousMediumPermeability from.
* @returns The new PorousMediumPermeability instance.
*/
static FromSquareCentimeters(value) {
return new PorousMediumPermeability(value, PorousMediumPermeabilityUnits.SquareCentimeters);
}
/**
* Create a new PorousMediumPermeability instance from a Microdarcys
*
* @param value The unit as Microdarcys to create a new PorousMediumPermeability from.
* @returns The new PorousMediumPermeability instance.
*/
static FromMicrodarcys(value) {
return new PorousMediumPermeability(value, PorousMediumPermeabilityUnits.Microdarcys);
}
/**
* Create a new PorousMediumPermeability instance from a Millidarcys
*
* @param value The unit as Millidarcys to create a new PorousMediumPermeability from.
* @returns The new PorousMediumPermeability instance.
*/
static FromMillidarcys(value) {
return new PorousMediumPermeability(value, PorousMediumPermeabilityUnits.Millidarcys);
}
/**
* Gets the base unit enumeration associated with PorousMediumPermeability
* @returns The unit enumeration that can be used to interact with this type
*/
static getUnitEnum() {
return PorousMediumPermeabilityUnits;
}
/**
* Gets the default unit used when creating instances of the unit or its DTO
* @returns The unit enumeration value used as a default parameter in constructor and DTO methods
*/
static getBaseUnit() {
return PorousMediumPermeabilityUnits.SquareMeters;
}
/**
* Create API DTO represent a PorousMediumPermeability unit.
* @param holdInUnit The specific PorousMediumPermeability unit to be used in the unit representation at the DTO
*/
toDto(holdInUnit = PorousMediumPermeabilityUnits.SquareMeters) {
return {
value: this.convert(holdInUnit),
unit: holdInUnit
};
}
/**
* Create a PorousMediumPermeability unit from an API DTO representation.
* @param dtoPorousMediumPermeability The PorousMediumPermeability API DTO representation
*/
static FromDto(dtoPorousMediumPermeability) {
return new PorousMediumPermeability(dtoPorousMediumPermeability.value, dtoPorousMediumPermeability.unit);
}
/**
* Convert PorousMediumPermeability to a specific unit value.
* @param toUnit The specific unit to convert to
* @returns The value of the specific unit provided.
*/
convert(toUnit) {
switch (toUnit) {
case PorousMediumPermeabilityUnits.Darcys: return this.Darcys;
case PorousMediumPermeabilityUnits.SquareMeters: return this.SquareMeters;
case PorousMediumPermeabilityUnits.SquareCentimeters: return this.SquareCentimeters;
case PorousMediumPermeabilityUnits.Microdarcys: return this.Microdarcys;
case PorousMediumPermeabilityUnits.Millidarcys: return this.Millidarcys;
default:
break;
}
return Number.NaN;
}
convertFromBase(toUnit) {
if (base_unit_1.areAnyOperatorsOverridden())
switch (toUnit) {
case PorousMediumPermeabilityUnits.Darcys: return super.internalDivide(this.value, 9.869233e-13);
case PorousMediumPermeabilityUnits.SquareMeters: return this.value;
case PorousMediumPermeabilityUnits.SquareCentimeters: return super.internalDivide(this.value, 1e-4);
case PorousMediumPermeabilityUnits.Microdarcys: {
const v3 = super.internalDivide(this.value, 9.869233e-13);
return super.internalDivide(v3, 0.000001);
}
case PorousMediumPermeabilityUnits.Millidarcys: {
const v3 = super.internalDivide(this.value, 9.869233e-13);
return super.internalDivide(v3, 0.001);
}
default: return Number.NaN;
}
switch (toUnit) {
case PorousMediumPermeabilityUnits.Darcys: return this.value / 9.869233e-13;
case PorousMediumPermeabilityUnits.SquareMeters: return this.value;
case PorousMediumPermeabilityUnits.SquareCentimeters: return this.value / 1e-4;
case PorousMediumPermeabilityUnits.Microdarcys: return (this.value / 9.869233e-13) / 0.000001;
case PorousMediumPermeabilityUnits.Millidarcys: return (this.value / 9.869233e-13) / 0.001;
default: return Number.NaN;
}
}
convertToBase(value, fromUnit) {
if (base_unit_1.areAnyOperatorsOverridden())
switch (fromUnit) {
case PorousMediumPermeabilityUnits.Darcys: return super.internalMultiply(value, 9.869233e-13);
case PorousMediumPermeabilityUnits.SquareMeters: return value;
case PorousMediumPermeabilityUnits.SquareCentimeters: return super.internalMultiply(value, 1e-4);
case PorousMediumPermeabilityUnits.Microdarcys: {
const v3 = super.internalMultiply(value, 9.869233e-13);
return super.internalMultiply(v3, 0.000001);
}
case PorousMediumPermeabilityUnits.Millidarcys: {
const v3 = super.internalMultiply(value, 9.869233e-13);
return super.internalMultiply(v3, 0.001);
}
default: return Number.NaN;
}
switch (fromUnit) {
case PorousMediumPermeabilityUnits.Darcys: return value * 9.869233e-13;
case PorousMediumPermeabilityUnits.SquareMeters: return value;
case PorousMediumPermeabilityUnits.SquareCentimeters: return value * 1e-4;
case PorousMediumPermeabilityUnits.Microdarcys: return (value * 9.869233e-13) * 0.000001;
case PorousMediumPermeabilityUnits.Millidarcys: return (value * 9.869233e-13) * 0.001;
default: return Number.NaN;
}
}
/**
* Format the PorousMediumPermeability to string.
* Note! the default format for PorousMediumPermeability is SquareMeters.
* To specify the unit format set the 'unit' parameter.
* @param unit The unit to format the PorousMediumPermeability.
* @param options The ToString options, it also can be the number of fractional digits to keep that deprecated and moved to the options object. support in number will be dropped in the upcoming versions.
* @returns The string format of the PorousMediumPermeability.
*/
toString(unit = PorousMediumPermeabilityUnits.SquareMeters, options) {
if (typeof options === 'number') {
console.warn('The number parameter is deprecated and moved to the options object. support in number will be dropped in the upcoming versions.');
options = { fractionalDigits: options };
}
switch (unit) {
case PorousMediumPermeabilityUnits.Darcys:
return super.truncateFractionDigits(this.Darcys, options) + ` D`;
case PorousMediumPermeabilityUnits.SquareMeters:
return super.truncateFractionDigits(this.SquareMeters, options) + ` m²`;
case PorousMediumPermeabilityUnits.SquareCentimeters:
return super.truncateFractionDigits(this.SquareCentimeters, options) + ` cm²`;
case PorousMediumPermeabilityUnits.Microdarcys:
return super.truncateFractionDigits(this.Microdarcys, options) + ` μD`;
case PorousMediumPermeabilityUnits.Millidarcys:
return super.truncateFractionDigits(this.Millidarcys, options) + ` mD`;
default:
break;
}
return this.value.toString();
}
/**
* Get PorousMediumPermeability unit abbreviation.
* Note! the default abbreviation for PorousMediumPermeability is SquareMeters.
* To specify the unit abbreviation set the 'unitAbbreviation' parameter.
* @param unitAbbreviation The unit abbreviation of the PorousMediumPermeability.
* @returns The abbreviation string of PorousMediumPermeability.
*/
getUnitAbbreviation(unitAbbreviation = PorousMediumPermeabilityUnits.SquareMeters) {
switch (unitAbbreviation) {
case PorousMediumPermeabilityUnits.Darcys:
return `D`;
case PorousMediumPermeabilityUnits.SquareMeters:
return `m²`;
case PorousMediumPermeabilityUnits.SquareCentimeters:
return `cm²`;
case PorousMediumPermeabilityUnits.Microdarcys:
return `μD`;
case PorousMediumPermeabilityUnits.Millidarcys:
return `mD`;
default:
break;
}
return '';
}
/**
* Check if the given PorousMediumPermeability are equals to the current PorousMediumPermeability.
* @param porousMediumPermeability The other PorousMediumPermeability.
* @returns True if the given PorousMediumPermeability are equal to the current PorousMediumPermeability.
*/
equals(porousMediumPermeability) {
return super.internalEquals(this.value, porousMediumPermeability.BaseValue);
}
/**
* Compare the given PorousMediumPermeability against the current PorousMediumPermeability.
* @param porousMediumPermeability The other PorousMediumPermeability.
* @returns 0 if they are equal, -1 if the current PorousMediumPermeability is less then other, 1 if the current PorousMediumPermeability is greater then other.
*/
compareTo(porousMediumPermeability) {
return super.internalCompareTo(this.value, porousMediumPermeability.BaseValue);
}
/**
* Add the given PorousMediumPermeability with the current PorousMediumPermeability.
* @param porousMediumPermeability The other PorousMediumPermeability.
* @returns A new PorousMediumPermeability instance with the results.
*/
add(porousMediumPermeability) {
return new PorousMediumPermeability(super.internalAdd(this.value, porousMediumPermeability.BaseValue));
}
/**
* Subtract the given PorousMediumPermeability with the current PorousMediumPermeability.
* @param porousMediumPermeability The other PorousMediumPermeability.
* @returns A new PorousMediumPermeability instance with the results.
*/
subtract(porousMediumPermeability) {
return new PorousMediumPermeability(super.internalSubtract(this.value, porousMediumPermeability.BaseValue));
}
/**
* Multiply the given PorousMediumPermeability with the current PorousMediumPermeability.
* @param porousMediumPermeability The other PorousMediumPermeability.
* @returns A new PorousMediumPermeability instance with the results.
*/
multiply(porousMediumPermeability) {
return new PorousMediumPermeability(super.internalMultiply(this.value, porousMediumPermeability.BaseValue));
}
/**
* Divide the given PorousMediumPermeability with the current PorousMediumPermeability.
* @param porousMediumPermeability The other PorousMediumPermeability.
* @returns A new PorousMediumPermeability instance with the results.
*/
divide(porousMediumPermeability) {
return new PorousMediumPermeability(super.internalDivide(this.value, porousMediumPermeability.BaseValue));
}
/**
* Modulo the given PorousMediumPermeability with the current PorousMediumPermeability.
* @param porousMediumPermeability The other PorousMediumPermeability.
* @returns A new PorousMediumPermeability instance with the results.
*/
modulo(porousMediumPermeability) {
return new PorousMediumPermeability(super.internalModulo(this.value, porousMediumPermeability.BaseValue));
}
/**
* Pow the given PorousMediumPermeability with the current PorousMediumPermeability.
* @param porousMediumPermeability The other PorousMediumPermeability.
* @returns A new PorousMediumPermeability instance with the results.
*/
pow(porousMediumPermeability) {
return new PorousMediumPermeability(super.internalPow(this.value, porousMediumPermeability.BaseValue));
}
}
exports.PorousMediumPermeability = PorousMediumPermeability;