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

Cylinder with one pointed end and one circular end. More...

#include <CD_NeedleIF.H>

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

Public Member Functions

 NeedleIF (const Real &a_length, const Real &a_radius, const Real &a_tipRadius, const Real &a_angle, const bool &a_flipInside)
 Constructor. More...
 
 NeedleIF (const NeedleIF &a_inputIF)
 Copy constructor. More...
 
virtual Real value (const RealVect &a_point) const override
 Value function. Returns distance to object. More...
 
virtual BaseIF * newImplicitFunction () const override
 IF factory method.
 

Protected Attributes

RefCountedPtr< BaseIF > m_implicitFunction
 Base implicit function. This is a union between a cylinder and a cone.
 
Real m_tipRadius
 curvature-radius of needle tip
 

Detailed Description

Cylinder with one pointed end and one circular end.

Constructor & Destructor Documentation

◆ NeedleIF() [1/2]

NeedleIF::NeedleIF ( const Real &  a_length,
const Real &  a_radius,
const Real &  a_tipRadius,
const Real &  a_angle,
const bool &  a_flipInside 
)

Constructor.

Parameters
[in]a_lengthNeedle length
[in]a_radiusNeedle radius
[in]a_tipRadiusSmoothing radius for tip and transition
[in]a_angleNeedle tip (cone) opening angle
[in]flipInsideFlip inside to outside

◆ NeedleIF() [2/2]

NeedleIF::NeedleIF ( const NeedleIF a_inputIF)

Copy constructor.

Parameters
[in]a_inputIFInput Needle

Member Function Documentation

◆ value()

Real NeedleIF::value ( const RealVect &  a_point) const
overridevirtual

Value function. Returns distance to object.

Parameters
[in]a_pointPhysical position.

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