chombo-discharge
Public Member Functions | Protected Attributes | List of all members
HyperboloidOneIF Class Reference

Declaration of a one-sheet hyperboloid. More...

#include <CD_HyperboloidOneIF.H>

Inheritance diagram for HyperboloidOneIF:
Inheritance graph
[legend]
Collaboration diagram for HyperboloidOneIF:
Collaboration graph
[legend]

Public Member Functions

 HyperboloidOneIF (const RealVect &a_radii, const RealVect &a_center, const bool &a_inside)
 Constructor. More...
 
 HyperboloidOneIF (const HyperboloidOneIF &a_inputIF)
 Copy constructor. More...
 
virtual Real value (const RealVect &a_point) const
 Test whether inside or not. More...
 
virtual BaseIF * newImplicitFunction () const
 IF factory method.
 

Protected Attributes

RealVect m_radii
 Hyperboloid radii.
 
RealVect m_radii2
 Hyperboloid radii squared.
 
RealVect m_sign
 Holder for sign convention.
 
RealVect m_center
 Hyperboloid center.
 
bool m_inside
 Inside or outside domain.
 

Detailed Description

Declaration of a one-sheet hyperboloid.

The implicit function used for the sheet is

\[ \frac{x^2}{a^2} + \frac{y^2}{b^2} - \frac{z^2}{c^2} = 1. \]

Constructor & Destructor Documentation

◆ HyperboloidOneIF() [1/2]

HyperboloidOneIF::HyperboloidOneIF ( const RealVect &  a_radii,
const RealVect &  a_center,
const bool &  a_inside 
)

Constructor.

Parameters
[in]a_radiiHyperboloid radii
[in]a_centerHyperboloid center
[in]a_insideDomain on inside or outside

◆ HyperboloidOneIF() [2/2]

HyperboloidOneIF::HyperboloidOneIF ( const HyperboloidOneIF a_inputIF)

Copy constructor.

Parameters
[in]a_inputIFInput one-sheeted hyperboloid

Member Function Documentation

◆ value()

Real HyperboloidOneIF::value ( const RealVect &  a_point) const
virtual

Test whether inside or not.

Parameters
[in]a_pointPhysical position.

The documentation for this class was generated from the following files: