Public Member Functions | Protected Attributes | List of all members
oomph::SimpleCircle Class Reference

Simple circle in 2D space. More...

#include <circle.h>

Inheritance diagram for oomph::SimpleCircle:

Public Member Functions

 SimpleCircle (const double &x_c, const double &y_c, const double &r)
 Constructor: Pass x and y-coords of centre and radius.
 
void position (const Vector< double > &zeta, Vector< double > &r) const
 Position Vector at Lagrangian coordinate zeta.
 
void position (const unsigned &t, const Vector< double > &zeta, Vector< double > &r) const
 Position Vector at Lagrangian coordinate zeta at time level t (t=0: present; t>0: previous level). Steady object, so we simply forward the call to the steady version.
 

Protected Attributes

double X_c
 X-coordinate of centre.
 
double Y_c
 Y-coordinate of centre.
 
double R
 Radius.
 

Detailed Description

Simple circle in 2D space.

\[ x = X_c + R \cos(\zeta) \]

\[ y = Y_c + R \sin(\zeta) \]

Definition at line 41 of file circle.h.

Constructor & Destructor Documentation

◆ SimpleCircle()

oomph::SimpleCircle::SimpleCircle ( const double &  x_c,
const double &  y_c,
const double &  r 
)
inline

Constructor: Pass x and y-coords of centre and radius.

Definition at line 47 of file circle.h.

Member Function Documentation

◆ position() [1/2]

void oomph::SimpleCircle::position ( const unsigned &  t,
const Vector< double > &  zeta,
Vector< double > &  r 
) const
inline

Position Vector at Lagrangian coordinate zeta at time level t (t=0: present; t>0: previous level). Steady object, so we simply forward the call to the steady version.

Definition at line 62 of file circle.h.

References demo_fish_poisson(), and position().

◆ position() [2/2]

void oomph::SimpleCircle::position ( const Vector< double > &  zeta,
Vector< double > &  r 
) const
inline

Position Vector at Lagrangian coordinate zeta.

Definition at line 52 of file circle.h.

References demo_fish_poisson(), R, X_c, and Y_c.

Referenced by position().

Member Data Documentation

◆ R

double oomph::SimpleCircle::R
protected

Radius.

Definition at line 75 of file circle.h.

Referenced by position().

◆ X_c

double oomph::SimpleCircle::X_c
protected

X-coordinate of centre.

Definition at line 69 of file circle.h.

Referenced by position().

◆ Y_c

double oomph::SimpleCircle::Y_c
protected

Y-coordinate of centre.

Definition at line 72 of file circle.h.

Referenced by position().

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