curved::Shape Struct Reference

An analytic surface onto which the faces of a boundary zone are projected: a circle (2D) or a sphere or circular cylinder (3D). More...

#include <curved.h>

Public Types
enum class	Kind : uint8_t { CIRCLE , SPHERE , CYLINDER }

Public Member Functions
void	project (const Vec3 &x, Vec3 &p, double *J) const
	Radial projection p of x onto the shape, and dp/dx (row-major 3 x 3).

Public Attributes
Kind	kind = Kind::CIRCLE
std::string	zone
Vec3	center = {0.0, 0.0, 0.0}
Vec3	axis = {0.0, 0.0, 1.0}
double	radius = 1.0

Detailed Description

An analytic surface onto which the faces of a boundary zone are projected: a circle (2D) or a sphere or circular cylinder (3D).

Member Enumeration Documentation

Kind

enum class curved::Shape::Kind : uint8_t

strong

Enumerator
CIRCLE
SPHERE
CYLINDER

Member Function Documentation

project()

void curved::Shape::project	(	const Vec3 &	x,
		Vec3 &	p,
		double *	J
	)		const

Radial projection p of x onto the shape, and dp/dx (row-major 3 x 3).

Member Data Documentation

axis

Vec3 curved::Shape::axis = {0.0, 0.0, 1.0}

center

Vec3 curved::Shape::center = {0.0, 0.0, 0.0}

kind

Kind curved::Shape::kind = Kind::CIRCLE

radius

double curved::Shape::radius = 1.0

zone

std::string curved::Shape::zone

---

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

• /home/runner/work/mallard/mallard/mallard/src/mesh/curved.h
• /home/runner/work/mallard/mallard/mallard/src/mesh/curved.cpp