---
name: "sc_Volume"
section: "3"
platform: "linux"
package: "libsc-doc"
version: "2.3.1-22"
release: "Debian 12 (Bookworm)"
platforms: ["linux"]
url: "https://new.carta.tech/sc_Volume"
---

# sc\_Volume(3)

A Volume is a Function of three variables.

## NAME

sc::Volume - A **Volume** is a **Function** of three variables.

## SYNOPSIS

`#include <volume.h>`

Inherits **sc::Function**.

Inherited by **sc::BatchElectronDensity**, **sc::ElectronDensity**, **sc::Orbital**, and **sc::Shape**.

### Public Member Functions

**Volume** (const **Ref**\< **KeyVal** \> &)\
 void **set\_gradient** (const **SCVector3** &g)\
 void **set\_gradient** (**RefSCVector** &g)\
 void **get\_gradient** (**SCVector3** &g)\
 void **set\_x** (const **SCVector3** &x)\
 void **set\_x** (const **RefSCVector** &x)\
 Set and retrieve the coordinate values.  void **get\_x** (**SCVector3** &x)\
 virtual void **boundingbox** (double valuemin, double valuemax, **SCVector3** &p1, **SCVector3** &p2)=0\
 virtual void **interpolate** (const **SCVector3** &p1, const **SCVector3** &p2, double **value**, **SCVector3** &result)\
 virtual void **solve** (const **SCVector3** &p, const **SCVector3** &grad, double **value**, **SCVector3** &result)\

### Protected Member Functions

double & **interpolation\_accuracy** ()\
 virtual void **compute** ()=0\
 Recompute at least the results that have compute true and are not already computed.  virtual void **failure** (const char \*)\

### Additional Inherited Members

## Detailed Description

A **Volume** is a **Function** of three variables.

## Member Function Documentation

### virtual void sc::Volume::boundingbox (double valuemin, double valuemax, SCVector3 & p1, SCVector3 & p2)` [pure virtual]`

Implemented in **sc::BatchElectronDensity**.

### virtual void sc::Volume::compute ()` [protected]`, ` [pure virtual]`

Recompute at least the results that have compute true and are not already computed. This should only be called by **Result**'s members.

Implements **sc::Compute**.

Implemented in **sc::ElectronDensity**, **sc::BatchElectronDensity**, **sc::Orbital**, and **sc::Shape**.

### void sc::Volume::set\_gradient (RefSCVector & g)` [virtual]`

Reimplemented from **sc::Function**.

### void sc::Volume::set\_x (const RefSCVector &)` [virtual]`

Set and retrieve the coordinate values.

Reimplemented from **sc::Function**.

## Author

Generated automatically by Doxygen for MPQC from the source code.
