|
seams-core v2.14.0
libyodaLib, the C++ engine of d-SEAMS
|
Planar front, rejection coefficient, profile, and pockets. More...
Functions | |
| SEAMS_API seams_status | seams_brine_analyse (seams_system *sys, const int *ice, size_t n_ice, int water_type, int ion_type, int n_bins, int axis, seams_brine **out) |
| Planar ice/brine front from an ice assignment. | |
| SEAMS_API void | seams_brine_destroy (seams_brine *front) |
| Free a brine-front handle. | |
| SEAMS_API seams_status | seams_brine_fronts (const seams_brine *front, double *z_enter, double *z_exit, double *thickness, int *found) |
| The two planar crossings of the ice slab. | |
| SEAMS_API seams_status | seams_brine_rejection (const seams_brine *front, double *c_ice, double *c_liquid, double *k, int *defined) |
| Molal rejection coefficient k = c_ice / c_liquid. | |
| SEAMS_API seams_status | seams_brine_profile (const seams_brine *front, double *z_mid, double *molality, double *ice_fraction, size_t cap, size_t *n_out) |
| Concentration profile along the front axis. | |
| SEAMS_API seams_status | seams_brine_pockets (const seams_brine *front, int *n_pockets, int *reservoir_waters) |
| Brine pockets trapped in the ice, excluding the liquid reservoir. | |
Planar front, rejection coefficient, profile, and pockets.
| SEAMS_API seams_status seams_brine_analyse | ( | seams_system * | sys, |
| const int * | ice, | ||
| size_t | n_ice, | ||
| int | water_type, | ||
| int | ion_type, | ||
| int | n_bins, | ||
| int | axis, | ||
| seams_brine ** | out ) |
Planar ice/brine front from an ice assignment.
ice[i] is non-zero when atom i is ice. water_type 0 keeps every atom whose type is not ion_type. ion_type 0 means the frame has no ions. n_bins 0 selects 20 bins. axis is 0, 1, or 2. The ice fraction cut is 0.5, and the bulk ice and liquid cuts are 0.85 and 0.15.
| sys | Frame handle. |
| ice | Per-atom ice flags, length n_ice. |
| n_ice | Must equal the frame count. |
| water_type | Species kept as water, or 0. |
| ion_type | Species kept as ions, or 0 for none. |
| n_bins | Bin count along axis, or 0 for 20. |
| axis | 0, 1, or 2. |
| out | Receives a new handle. On failure *out is NULL. |
| SEAMS_API void seams_brine_destroy | ( | seams_brine * | front | ) |
Free a brine-front handle.
| front | Handle from seams_brine_analyse(), or NULL. NULL is ignored. |
| SEAMS_API seams_status seams_brine_fronts | ( | const seams_brine * | front, |
| double * | z_enter, | ||
| double * | z_exit, | ||
| double * | thickness, | ||
| int * | found ) |
The two planar crossings of the ice slab.
Lengths are Angstrom, in the frame's cell.
| front | Brine handle. |
| z_enter | Where the ice fraction crosses the cut on entering the ice along the positive axis, or NULL. |
| z_exit | The crossing on leaving the ice, or NULL. |
| thickness | Ice run along the axis, or NULL. |
| found | Receives 1 when both crossings exist, otherwise 0, or NULL. |
| SEAMS_API seams_status seams_brine_pockets | ( | const seams_brine * | front, |
| int * | n_pockets, | ||
| int * | reservoir_waters ) |
Brine pockets trapped in the ice, excluding the liquid reservoir.
| front | Brine handle. |
| n_pockets | Receives the pocket count, or NULL. |
| reservoir_waters | Receives the water count of the liquid reservoir, or NULL. |
| SEAMS_API seams_status seams_brine_profile | ( | const seams_brine * | front, |
| double * | z_mid, | ||
| double * | molality, | ||
| double * | ice_fraction, | ||
| size_t | cap, | ||
| size_t * | n_out ) |
Concentration profile along the front axis.
z_mid is Angstrom. molality is mol/kg. ice_fraction is dimensionless.
| front | Brine handle. |
| z_mid | Bin centers, or NULL to skip the column. |
| molality | Bin molalities, or NULL to skip the column. |
| ice_fraction | Bin ice fractions, or NULL to skip the column. |
| cap | Capacity of each non-NULL column. |
| n_out | Receives the bin count. |
| SEAMS_API seams_status seams_brine_rejection | ( | const seams_brine * | front, |
| double * | c_ice, | ||
| double * | c_liquid, | ||
| double * | k, | ||
| int * | defined ) |
Molal rejection coefficient k = c_ice / c_liquid.
Molality is formula units per kilogram of water.
| front | Brine handle. |
| c_ice | Bulk ice molality, or NULL. |
| c_liquid | Bulk liquid molality, or NULL. |
| k | The ratio, or NULL. Unchanged when the ratio is undefined. |
| defined | Receives 1 when the liquid bulk contains salt or the ice bulk does not, otherwise 0, or NULL. |