.TH "sc::Shape" 3 "Sun Oct 4 2020" "Version 2.3.1" "MPQC" \" -*- nroff -*-
.ad l
.nh
.SH NAME
sc::Shape \- A \fBShape\fP is a \fBVolume\fP represents an 3D solid\&.  

.SH SYNOPSIS
.br
.PP
.PP
\fC#include <shape\&.h>\fP
.PP
Inherits \fBsc::Volume\fP\&.
.PP
Inherited by \fBsc::ConnollyShape\fP, \fBsc::SphereShape\fP, \fBsc::Uncapped5SphereExclusionShape\fP, \fBsc::UncappedTorusHoleShape\fP, and \fBsc::UnionShape\fP\&.
.SS "Public Member Functions"

.in +1c
.ti -1c
.RI "\fBShape\fP (const \fBRef\fP< \fBKeyVal\fP > &keyval)"
.br
.ti -1c
.RI "virtual double \fBdistance_to_surface\fP (const \fBSCVector3\fP &r, \fBSCVector3\fP *grad=0) const =0"
.br
.ti -1c
.RI "virtual int \fBis_outside\fP (const \fBSCVector3\fP &r) const"
.br
.ti -1c
.RI "void \fBcompute\fP ()"
.br
.RI "Recompute at least the results that have compute true and are not already computed\&. "
.ti -1c
.RI "void \fBinterpolate\fP (const \fBSCVector3\fP &p1, const \fBSCVector3\fP &p2, double val, \fBSCVector3\fP &result)"
.br
.ti -1c
.RI "int \fBvalue_implemented\fP () const"
.br
.RI "Information about the availability of values, gradients, and hessians\&. "
.in -1c
.SS "Additional Inherited Members"
.SH "Detailed Description"
.PP 
A \fBShape\fP is a \fBVolume\fP represents an 3D solid\&. 

The value of the \fBShape\fP at each point in space is the distance to the surface\&. The distance is negative if the point is inside the solid\&. For \fBShape\fP specializations that cannot compute the distance to the surface, the value will be 1\&.0 outside and -1\&.0 inside the solid\&. 
.SH "Member Function Documentation"
.PP 
.SS "void sc::Shape::compute ()\fC [virtual]\fP"

.PP
Recompute at least the results that have compute true and are not already computed\&. This should only be called by \fBResult\fP's members\&. 
.PP
Implements \fBsc::Volume\fP\&.

.SH "Author"
.PP 
Generated automatically by Doxygen for MPQC from the source code\&.