#include <geom_objects.h>

Inheritance diagram for oomph::Ellipse:

Public Member Functions
	Ellipse (const Vector< Data * > &geom_data_pt)

	Ellipse (const double &A, const double &B)

	Ellipse (const Ellipse &dummy)=delete
	Broken copy constructor. More...

void	operator= (const Ellipse &)=delete
	Broken assignment operator. More...

	~Ellipse ()
	Destructor: Clean up if necessary. More...

void	set_A_ellips (const double &a)
	Set horizontal half axis. More...

void	set_B_ellips (const double &b)
	Set vertical half axis. More...

double	a_ellips ()
	Access function for horizontal half axis. More...

double	b_ellips ()
	Access function for vertical half axis. More...

void	position (const Vector< double > &zeta, Vector< double > &r) const
	Position Vector at Lagrangian coordinate zeta. More...

void	position (const unsigned &t, const Vector< double > &zeta, Vector< double > &r) const

void	dposition (const Vector< double > &zeta, DenseMatrix< double > &drdzeta) const

void	d2position (const Vector< double > &zeta, RankThreeTensor< double > &ddrdzeta) const

void	d2position (const Vector< double > &zeta, Vector< double > &r, DenseMatrix< double > &drdzeta, RankThreeTensor< double > &ddrdzeta) const

unsigned	ngeom_data () const
	How many items of Data does the shape of the object depend on? More...

Data *	geom_data_pt (const unsigned &j)

Public Member Functions inherited from oomph::GeomObject
	GeomObject ()
	Default constructor. More...

	GeomObject (const unsigned &ndim)

	GeomObject (const unsigned &nlagrangian, const unsigned &ndim)

	GeomObject (const unsigned &nlagrangian, const unsigned &ndim, TimeStepper *time_stepper_pt)

	GeomObject (const GeomObject &dummy)=delete
	Broken copy constructor. More...

void	operator= (const GeomObject &)=delete
	Broken assignment operator. More...

virtual	~GeomObject ()
	(Empty) destructor More...

unsigned	nlagrangian () const
	Access function to # of Lagrangian coordinates. More...

unsigned	ndim () const
	Access function to # of Eulerian coordinates. More...

void	set_nlagrangian_and_ndim (const unsigned &n_lagrangian, const unsigned &n_dim)
	Set # of Lagrangian and Eulerian coordinates. More...

TimeStepper *&	time_stepper_pt ()

TimeStepper *	time_stepper_pt () const

virtual void	position (const double &t, const Vector< double > &zeta, Vector< double > &r) const

virtual void	dposition_dt (const Vector< double > &zeta, const unsigned &j, Vector< double > &drdt)

virtual void	locate_zeta (const Vector< double > &zeta, GeomObject *&sub_geom_object_pt, Vector< double > &s, const bool &use_coordinate_as_initial_guess=false)

virtual void	interpolated_zeta (const Vector< double > &s, Vector< double > &zeta) const

Private Attributes
Vector< Data * >	Geom_data_pt
	Vector of pointers to Data items that affects the object's shape. More...

bool	Must_clean_up
	Do I need to clean up? More...

Additional Inherited Members
Protected Attributes inherited from oomph::GeomObject
unsigned	NLagrangian
	Number of Lagrangian (intrinsic) coordinates. More...

unsigned	Ndim
	Number of Eulerian coordinates. More...

TimeStepper *	Geom_object_time_stepper_pt

Detailed Description

//////////////////////////////////////////////////////////////////// //////////////////////////////////////////////////////////////////// //////////////////////////////////////////////////////////////////// //////////////////////////////////////////////////////////////////// Steady ellipse with half axes A and B as geometric object:

\[ x = A \cos(\zeta) \]

\[ y = B \sin(\zeta) \]

Constructor & Destructor Documentation

◆ Ellipse() [1/3]

oomph::Ellipse::Ellipse ( const Vector< Data * > & geom_data_pt )

inline

Constructor: 1 Lagrangian coordinate, 2 Eulerian coords. Pass half axes as Data:

Geom_data_pt[0]->value(0) = A

Geom_data_pt[0]->value(1) = B

A

Matrix< SCALARA, Dynamic, Dynamic, opt_A > A

Definition: bench_gemm.cpp:47

oomph::Ellipse::Geom_data_pt

Vector< Data * > Geom_data_pt

Vector of pointers to Data items that affects the object's shape.

Definition: geom_objects.h:853

oomph::Matrix

Definition: matrices.h:74

                                                : GeomObject(1, 2)
     {
 #ifdef PARANOID
       if (geom_data_pt.size() != 1)
       {
         std::ostringstream error_message;
         error_message << "geom_data_pt should have size 1, not "
                       << geom_data_pt.size() << std::endl;
  
         if (geom_data_pt[0]->nvalue() != 2)
         {
           error_message << "geom_data_pt[0] should have 2 values, not "
                         << geom_data_pt[0]->nvalue() << std::endl;
         }
  
         throw OomphLibError(error_message.str(),
                             OOMPH_CURRENT_FUNCTION,
                             OOMPH_EXCEPTION_LOCATION);
       }
 #endif
       Geom_data_pt.resize(1);
       Geom_data_pt[0] = geom_data_pt[0];
  
       // Data has been created externally: Must not clean up
       Must_clean_up = false;
     }

References geom_data_pt(), Geom_data_pt, Must_clean_up, oomph::Data::nvalue(), OOMPH_CURRENT_FUNCTION, and OOMPH_EXCEPTION_LOCATION.

◆ Ellipse() [2/3]

oomph::Ellipse::Ellipse	(	const double &	A,
		const double &	B
	)

inline

Constructor: 1 Lagrangian coordinate, 2 Eulerian coords. Pass half axes A and B; both pinned.

                                               : GeomObject(1, 2)
     {
       // Resize Data for ellipse object:
       Geom_data_pt.resize(1);
  
       // Create data: Two values, no timedependence, free by default
       Geom_data_pt[0] = new Data(2);
  
       // I've created the data, I need to clean up
       Must_clean_up = true;
  
       // Pin the data
       Geom_data_pt[0]->pin(0);
       Geom_data_pt[0]->pin(1);
  
       // Set half axes
       Geom_data_pt[0]->set_value(0, A);
       Geom_data_pt[0]->set_value(1, B);
     }

References Geom_data_pt, and Must_clean_up.

◆ Ellipse() [3/3]

oomph::Ellipse::Ellipse ( const Ellipse & dummy )

delete

Broken copy constructor.

◆ ~Ellipse()

oomph::Ellipse::~Ellipse ( )

inline

Destructor: Clean up if necessary.

     {
       // Do I need to clean up?
       if (Must_clean_up)
       {
         delete Geom_data_pt[0];
         Geom_data_pt[0] = 0;
       }
     }

References Geom_data_pt, and Must_clean_up.

Member Function Documentation

◆ a_ellips()

double oomph::Ellipse::a_ellips ( )

inline

Access function for horizontal half axis.

     {
       return Geom_data_pt[0]->value(0);
     }

References Geom_data_pt.

◆ b_ellips()

double oomph::Ellipse::b_ellips ( )

inline

Access function for vertical half axis.

     {
       return Geom_data_pt[0]->value(1);
     }

References Geom_data_pt.

◆ d2position() [1/2]

void oomph::Ellipse::d2position	(	const Vector< double > &	zeta,
		RankThreeTensor< double > &	ddrdzeta
	)		const

inlinevirtual

2nd derivative of position Vector w.r.t. to coordinates: \( \frac{d^2R_i}{d \zeta_\alpha d \zeta_\beta}\) = ddrdzeta(alpha,beta,i). Evaluated at current time.

Reimplemented from oomph::GeomObject.

     {
       // Components of the derivative of the tangent Vector
       ddrdzeta(0, 0, 0) = -Geom_data_pt[0]->value(0) * cos(zeta[0]);
       ddrdzeta(0, 0, 1) = -Geom_data_pt[0]->value(1) * sin(zeta[0]);
     }

References cos(), Geom_data_pt, sin(), and Eigen::zeta().

◆ d2position() [2/2]

void oomph::Ellipse::d2position	(	const Vector< double > &	zeta,
		Vector< double > &	r,
		DenseMatrix< double > &	drdzeta,
		RankThreeTensor< double > &	ddrdzeta
	)		const

inlinevirtual

Position Vector and 1st and 2nd derivs to coordinates: \( \frac{dR_i}{d \zeta_\alpha}\) = drdzeta(alpha,i). \( \frac{d^2R_i}{d \zeta_\alpha d \zeta_\beta}\) = ddrdzeta(alpha,beta,i). Evaluated at current time.

Reimplemented from oomph::GeomObject.

     {
       double a = Geom_data_pt[0]->value(0);
       double b = Geom_data_pt[0]->value(1);
       // Position Vector
       r[0] = a * cos(zeta[0]);
       r[1] = b * sin(zeta[0]);
  
       // Components of the single tangent Vector
       drdzeta(0, 0) = -a * sin(zeta[0]);
       drdzeta(0, 1) = b * cos(zeta[0]);
  
       // Components of the derivative of the tangent Vector
       ddrdzeta(0, 0, 0) = -a * cos(zeta[0]);
       ddrdzeta(0, 0, 1) = -b * sin(zeta[0]);
     }

References a, b, cos(), Geom_data_pt, UniformPSDSelfTest::r, sin(), and Eigen::zeta().

◆ dposition()

void oomph::Ellipse::dposition	(	const Vector< double > &	zeta,
		DenseMatrix< double > &	drdzeta
	)		const

inlinevirtual

Derivative of position Vector w.r.t. to coordinates: \( \frac{dR_i}{d \zeta_\alpha}\) = drdzeta(alpha,i).

Reimplemented from oomph::GeomObject.

     {
       // Components of the single tangent Vector
       drdzeta(0, 0) = -Geom_data_pt[0]->value(0) * sin(zeta[0]);
       drdzeta(0, 1) = Geom_data_pt[0]->value(1) * cos(zeta[0]);
     }

References cos(), Geom_data_pt, sin(), and Eigen::zeta().

◆ geom_data_pt()

Data* oomph::Ellipse::geom_data_pt ( const unsigned & j )

inlinevirtual

Return pointer to the j-th Data item that the object's shape depends on

Reimplemented from oomph::GeomObject.

     {
       return Geom_data_pt[j];
     }

References Geom_data_pt, and j.

Referenced by Ellipse().

◆ ngeom_data()

unsigned oomph::Ellipse::ngeom_data ( ) const

inlinevirtual

How many items of Data does the shape of the object depend on?

Reimplemented from oomph::GeomObject.

     {
       return Geom_data_pt.size();
     }

References Geom_data_pt.

◆ operator=()

void oomph::Ellipse::operator= ( const Ellipse & )

delete

Broken assignment operator.

◆ position() [1/2]

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

inlinevirtual

Parametrised position on object: r(zeta). Evaluated at previous timestep. t=0: current time; t>0: previous timestep.

Reimplemented from oomph::GeomObject.

     {
       // If we have done the construction, it's a Steady Ellipse,
       // so all time-history values of the position are equal to the position
       if (Must_clean_up)
       {
         position(zeta, r);
         return;
       }
  
       // Otherwise check that the value of t is within range
 #ifdef PARANOID
       if (t > Geom_data_pt[0]->time_stepper_pt()->nprev_values())
       {
         std::ostringstream error_message;
         error_message << "t > nprev_values() " << t << " "
                       << Geom_data_pt[0]->time_stepper_pt()->nprev_values()
                       << std::endl;
  
         throw OomphLibError(error_message.str(),
                             OOMPH_CURRENT_FUNCTION,
                             OOMPH_EXCEPTION_LOCATION);
       }
 #endif
  
       // Position Vector
       r[0] = Geom_data_pt[0]->value(t, 0) * cos(zeta[0]);
       r[1] = Geom_data_pt[0]->value(t, 1) * sin(zeta[0]);
     }

References cos(), Geom_data_pt, Must_clean_up, OOMPH_CURRENT_FUNCTION, OOMPH_EXCEPTION_LOCATION, position(), UniformPSDSelfTest::r, sin(), plotPSD::t, oomph::GeomObject::time_stepper_pt(), and Eigen::zeta().

◆ position() [2/2]

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

inlinevirtual

Position Vector at Lagrangian coordinate zeta.

Implements oomph::GeomObject.

     {
       // Position Vector
       r[0] = Geom_data_pt[0]->value(0) * cos(zeta[0]);
       r[1] = Geom_data_pt[0]->value(1) * sin(zeta[0]);
     }

References cos(), Geom_data_pt, UniformPSDSelfTest::r, sin(), and Eigen::zeta().

Referenced by AxisymmetricVibratingShellProblem< ELEMENT >::AxisymmetricVibratingShellProblem(), BubbleInChannelProblem< ELEMENT >::BubbleInChannelProblem(), DropInChannelProblem< ELEMENT >::DropInChannelProblem(), position(), UnstructuredFluidProblem< ELEMENT >::UnstructuredFluidProblem(), UnstructuredPoissonProblem< ELEMENT >::UnstructuredPoissonProblem(), VibratingShellProblem< ELEMENT >::VibratingShellProblem(), and oomph::TwoDAnnularMesh< ELEMENT >::wrap_into_annular_shape().

◆ set_A_ellips()

void oomph::Ellipse::set_A_ellips ( const double & a )

inline

Set horizontal half axis.

     {
       Geom_data_pt[0]->set_value(0, a);
     }

References a, and Geom_data_pt.

◆ set_B_ellips()

void oomph::Ellipse::set_B_ellips ( const double & b )

inline

Set vertical half axis.

     {
       Geom_data_pt[0]->set_value(1, b);
     }

References b, and Geom_data_pt.

Member Data Documentation

◆ Geom_data_pt

Vector<Data*> oomph::Ellipse::Geom_data_pt

private

Vector of pointers to Data items that affects the object's shape.

Referenced by a_ellips(), b_ellips(), d2position(), dposition(), Ellipse(), geom_data_pt(), ngeom_data(), position(), set_A_ellips(), set_B_ellips(), and ~Ellipse().

◆ Must_clean_up

bool oomph::Ellipse::Must_clean_up

private

Do I need to clean up?

Referenced by Ellipse(), position(), and ~Ellipse().

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

geom_objects.h

Public Member Functions

Private Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ Ellipse() [1/3]

◆ Ellipse() [2/3]

◆ Ellipse() [3/3]

◆ ~Ellipse()

Member Function Documentation

◆ a_ellips()

◆ b_ellips()

◆ d2position() [1/2]

◆ d2position() [2/2]

◆ dposition()

◆ geom_data_pt()

◆ ngeom_data()

◆ operator=()

◆ position() [1/2]

◆ position() [2/2]

◆ set_A_ellips()

◆ set_B_ellips()

Member Data Documentation

◆ Geom_data_pt

◆ Must_clean_up