Public Types | Public Member Functions | Private Attributes | List of all members
SimpleSpineMesh< ELEMENT > Class Template Reference

//////////////////////////////////////////////////////////////////// More...

Inheritance diagram for SimpleSpineMesh< ELEMENT >:

Public Types

typedef double(* HeightFctPt) (const double &x)
 Function pointer to function, h(x), that may be used to specify the "height" of the domain, by assigning the function values to the spine heights. More...
 

Public Member Functions

 SimpleSpineMesh (const unsigned &nx, const unsigned &ny, const double &lx, const double &h, GeomObject *substrate_pt, TimeStepper *time_stepper_pt=&Mesh::Default_TimeStepper)
 Constructor: Pass number of elements in x-direction, number of elements in y-direction, length in x direction, initial height of mesh, and pointer to timestepper (defaults to Steady timestepper) More...
 
HeightFctPtheight_fct_pt ()
 Access function: Pointer to height function. More...
 
double height_fct (const double &x)
 Height function – this is called by update_spine_heights() when spine heights are assigned. More...
 
void update_spine_heights ()
 Update the spine heights according to the function specified by height_fct_pt(). More...
 
virtual void spine_node_update (SpineNode *spine_node_pt)
 General node update function implements pure virtual function defined in SpineMesh base class and performs specific node update actions: Nodes are located along vertical "spines" that emanate from the "substrate" (the lower wall) specified by a GeomObject. More...
 

Private Attributes

double Default_height
 Default height. More...
 
HeightFctPt Height_fct_pt
 Pointer to height function. More...
 
GeomObject * Substrate_pt
 Pointer to GeomObject that specifies the "substrate" (the lower wall) More...
 

Detailed Description

template<class ELEMENT>
class SimpleSpineMesh< ELEMENT >

////////////////////////////////////////////////////////////////////

Simple spine mesh class derived from standard 2D mesh. Vertical lines of nodes are located on spines.

Definition at line 89 of file simple_spine_channel.cc.

Member Typedef Documentation

◆ HeightFctPt

template<class ELEMENT >
typedef double(* SimpleSpineMesh< ELEMENT >::HeightFctPt) (const double &x)

Function pointer to function, h(x), that may be used to specify the "height" of the domain, by assigning the function values to the spine heights.

Definition at line 110 of file simple_spine_channel.cc.

Constructor & Destructor Documentation

◆ SimpleSpineMesh()

template<class ELEMENT >
SimpleSpineMesh< ELEMENT >::SimpleSpineMesh ( const unsigned &  nx,
const unsigned &  ny,
const double &  lx,
const double &  h,
GeomObject *  substrate_pt,
TimeStepper *  time_stepper_pt = &Mesh::Default_TimeStepper 
)

Constructor: Pass number of elements in x-direction, number of elements in y-direction, length in x direction, initial height of mesh, and pointer to timestepper (defaults to Steady timestepper)

Constructor for spine 2D mesh: Pass number of elements in x-direction, number of elements in y-direction, axial length and height of layer, pointer to geometric object that specifies the substrate (the lower wall) and pointer to timestepper (defaults to Static timestepper).

The mesh contains a layer of spine-ified fluid elements (of type ELEMENT; e.g SpineElement<QCrouzeixRaviartElement<2>)

Definition at line 206 of file simple_spine_channel.cc.

References SimpleSpineMesh< ELEMENT >::Substrate_pt.

Member Function Documentation

◆ height_fct()

template<class ELEMENT >
double SimpleSpineMesh< ELEMENT >::height_fct ( const double &  x)
inline

Height function – this is called by update_spine_heights() when spine heights are assigned.

Definition at line 121 of file simple_spine_channel.cc.

◆ height_fct_pt()

template<class ELEMENT >
HeightFctPt& SimpleSpineMesh< ELEMENT >::height_fct_pt ( )
inline

Access function: Pointer to height function.

Definition at line 113 of file simple_spine_channel.cc.

◆ spine_node_update()

template<class ELEMENT >
virtual void SimpleSpineMesh< ELEMENT >::spine_node_update ( SpineNode *  spine_node_pt)
inlinevirtual

General node update function implements pure virtual function defined in SpineMesh base class and performs specific node update actions: Nodes are located along vertical "spines" that emanate from the "substrate" (the lower wall) specified by a GeomObject.

Definition at line 157 of file simple_spine_channel.cc.

◆ update_spine_heights()

template<class ELEMENT >
void SimpleSpineMesh< ELEMENT >::update_spine_heights ( )
inline

Update the spine heights according to the function specified by height_fct_pt().

Definition at line 137 of file simple_spine_channel.cc.

Member Data Documentation

◆ Default_height

template<class ELEMENT >
double SimpleSpineMesh< ELEMENT >::Default_height
private

Default height.

Definition at line 184 of file simple_spine_channel.cc.

◆ Height_fct_pt

template<class ELEMENT >
HeightFctPt SimpleSpineMesh< ELEMENT >::Height_fct_pt
private

Pointer to height function.

Definition at line 187 of file simple_spine_channel.cc.

◆ Substrate_pt

template<class ELEMENT >
GeomObject* SimpleSpineMesh< ELEMENT >::Substrate_pt
private

Pointer to GeomObject that specifies the "substrate" (the lower wall)

Definition at line 190 of file simple_spine_channel.cc.

Referenced by SimpleSpineMesh< ELEMENT >::SimpleSpineMesh().


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