Permeability object

Permeability(...)

This method creates a Permeability object.

Path

materialApi.materials()[name].Permeability

Prototype

odb_Permeability&
Permeability(double specificWeight,
             double inertialDragCoefficient,
             const odb_SequenceSequenceDouble& table,
             const odb_String& type,
             bool temperatureDependency,
             int dependencies);

Required arguments

specificWeight: A Double specifying the specific weight of the wetting liquid, $γ_{w}$ .
inertialDragCoefficient: A Double specifying The inertial drag coefficient of the wetting liquid, $γ_{w}$ .
table: An odb_SequenceSequenceDouble specifying the items described below.

Optional arguments

type: An odb_String specifying the type of permeability. Possible values are "ISOTROPIC", "ORTHOTROPIC", and "ANISOTROPIC". The default value is "ISOTROPIC".
temperatureDependency: A Boolean specifying whether the data depend on temperature. The default value is false.
dependencies: An Int specifying the number of field variable dependencies. The default value is 0.

Table data

If type=ISOTROPIC, the table data specify the following:

$k$ .
Void ratio, $e$ .
Temperature, if the data depend on temperature.

If type=ORTHOTROPIC, the table data specify the following:

$k_{11}$ .
$k_{22}$ .
$k_{33}$ .
Void ratio, $e$ .
Temperature, if the data depend on temperature.

If type=ANISOTROPIC, the table data specify the following:

$k_{11}$ .
$k_{12}$ .
$k_{22}$ .
$k_{13}$ .
$k_{23}$ .
$k_{33}$ .
Void ratio, $e$ .
Temperature, if the data depend on temperature.

Return value

A Permeability object.

Exceptions

RangeError.

Members

The Permeability object has members with the same names and descriptions as the arguments to the Permeability method.

In addition, the Permeability object can have the following members:

Prototype

odb_SaturationDependence saturationDependence() const;
odb_VelocityDependence velocityDependence() const;

saturationDependence: A SaturationDependence object specifying the dependence of the permeability of a material on the saturation of the wetting liquid.
velocityDependence: A VelocityDependence object specifying the dependence of the permeability of a material on the velocity of fluid flow.

Corresponding analysis keywords

PERMEABILITY

Permeability object

Access

Permeability(...)

Path

Prototype

Required arguments

Optional arguments

Table data

Return value

Exceptions

Members

Prototype

Corresponding analysis keywords