Sorption object

Sorption(...)

This method creates a Sorption object.

Path

materialApi.materials()[name].Sorption

Prototype

odb_Sorption&
Sorption(const odb_SequenceSequenceDouble& absorptionTable,
         const odb_String& lawAbsorption,
         bool exsorption,
         const odb_String& lawExsorption,
         double scanning,
         const odb_SequenceSequenceDouble& exsorptionTable);

Required arguments

absorptionTable: An odb_SequenceSequenceDouble specifying the items described below.

Optional arguments

lawAbsorption: An odb_String specifying absorption behavior. Possible values are "LOG" and "TABULAR". The default value is "TABULAR".
exsorption: A Boolean specifying whether the exsorption data is specified. The default value is false.
lawExsorption: An odb_String specifying exsorption behavior. Possible values are "LOG" and "TABULAR". The default value is "TABULAR".
scanning: A Double specifying the slope of the scanning line, ${(d u_{w} / d s) |}_{s}$ . This slope must be positive and larger than the slope of the absorption or exsorption behaviors. The default value is 0.0.
exsorptionTable: An odb_SequenceSequenceDouble specifying the items described below. The default value is an empty sequence.

Table data

If lawAbsorption=TABULAR or lawExsorption=TABULAR, the absorptionTable and exsorptionTable data respectively specify the following:

Pore pressure, $u_{w}$ .
Saturation, $s$ .

If lawAbsorption=LOG or lawExsorption=LOG, the absorptionTable and exsorptionTable data respectively specify the following:

A.
B.
$s_{0}$ .
$s_{1}$ .

Return value

A Sorption object.

Exceptions

RangeError.

Members

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

Corresponding analysis keywords

SORPTION