Prescribed zone: applies equation to every point. More...

#include <Zones.h>

Inheritance diagram for Nektar::SpatialDomains::ZonePrescribe:

Public Member Functions
	ZonePrescribe (int id, int domainID, const CompositeMap &domain, const int coordDim, LibUtilities::EquationSharedPtr xDeform, LibUtilities::EquationSharedPtr yDeform, LibUtilities::EquationSharedPtr zDeform)

	~ZonePrescribe () override=default
	Default destructor. More...

NekDouble	GetXDeform (NekDouble x, NekDouble y, NekDouble z, NekDouble t) const

NekDouble	GetYDeform (NekDouble x, NekDouble y, NekDouble z, NekDouble t) const

NekDouble	GetZDeform (NekDouble x, NekDouble y, NekDouble z, NekDouble t) const

LibUtilities::EquationSharedPtr	GetXDeformEquation () const
	Returns the equation for the prescribed motion in the x-coordinate. More...

LibUtilities::EquationSharedPtr	GetYDeformEquation () const
	Returns the equation for the prescribed motion in the y-coordinate. More...

LibUtilities::EquationSharedPtr	GetZDeformEquation () const
	Returns the equation for the prescribed motion in the z-coordinate. More...

Public Member Functions inherited from Nektar::SpatialDomains::ZoneBase
	ZoneBase (MovementType type, int indx, int domainID, CompositeMap domain, int coordDim)
	Constructor. More...

virtual	~ZoneBase ()=default
	Default destructor. More...

MovementType	GetMovementType () const
	Returns the type of movement. More...

CompositeMap	GetDomain () const
	Returns the domain the zone is on. More...

int &	GetId ()
	Returns the zone ID. More...

int &	GetDomainID ()
	Returns the ID of the domain making up this Zone. More...

bool	Move (NekDouble time)
	Performs the movement of the zone at. More...

std::vector< GeometrySharedPtr > const &	GetElements () const
	Returns all highest dimension elements in the zone. More...

bool &	GetMoved ()
	Returns the flag which states if the zone has moved in this timestep. More...

void	ClearBoundingBoxes ()
	Clears all bounding boxes associated with the zones elements. More...

Protected Member Functions
bool	v_Move (NekDouble time) final
	Virtual function for movement of the zone at. More...

virtual bool	v_Move (NekDouble time)
	Virtual function for movement of the zone at. More...

Protected Attributes
LibUtilities::EquationSharedPtr	m_xDeform
	Equation specifying prescribed motion in x-direction. More...

LibUtilities::EquationSharedPtr	m_yDeform
	Equation specifying prescribed motion in y-direction. More...

LibUtilities::EquationSharedPtr	m_zDeform
	Equation specifying prescribed motion in z-direction. More...

Protected Attributes inherited from Nektar::SpatialDomains::ZoneBase
MovementType	m_type = MovementType::eNone
	Type of zone movement. More...

int	m_id
	Zone ID. More...

int	m_domainID
	ID for the composite making up this zone. More...

CompositeMap	m_domain
	Zone domain. More...

std::vector< GeometrySharedPtr >	m_elements
	Vector of highest dimension zone elements. More...

bool	m_moved = true
	Moved flag. More...

int	m_coordDim
	Coordinate dimension. More...

std::vector< PointGeomSharedPtr >	m_verts
	Vector of all points in the zone. More...

std::vector< CurveSharedPtr >	m_curves
	Vector of all curves in the zone. More...

std::vector< PointGeom >	m_origVerts
	Vector of all points in the zone at initialisation. More...

Detailed Description

Prescribed zone: applies equation to every point.

Definition at line 243 of file Zones.h.

Constructor & Destructor Documentation

◆ ZonePrescribe()

Nektar::SpatialDomains::ZonePrescribe::ZonePrescribe	(	int	id,
		int	domainID,
		const CompositeMap &	domain,
		const int	coordDim,
		LibUtilities::EquationSharedPtr	xDeform,
		LibUtilities::EquationSharedPtr	yDeform,
		LibUtilities::EquationSharedPtr	zDeform
	)

inline

Constructor for prescribed zone

Parameters

id	Zone ID
domainID	ID associated with the the domain making up the zone
domain	Domain that the zone consists of
coordDim	Coordinate dimension
xDeform	Equation for prescribed motion of x-coordinate
yDeform	Equation for prescribed motion of y-coordinate
zDeform	Equation for prescribed motion of z-coordinate

Definition at line 257 of file Zones.h.

        : ZoneBase(MovementType::ePrescribe, id, domainID, domain, coordDim),
          m_xDeform(xDeform), m_yDeform(yDeform), m_zDeform(zDeform)
    {
    }

◆ ~ZonePrescribe()

Nektar::SpatialDomains::ZonePrescribe::~ZonePrescribe ( )

overridedefault

Default destructor.

Member Function Documentation

◆ GetXDeform()

NekDouble Nektar::SpatialDomains::ZonePrescribe::GetXDeform	(	NekDouble	x,
		NekDouble	y,
		NekDouble	z,
		NekDouble	t
	)		const

inline

Returns point

Parameters

x

param y

Parameters

z	deformation in the x direction at time
t
x	x-coordinate
y	y-coordinate
z	z-coordinate
t	time

Returns: deformation in x direction

Definition at line 278 of file Zones.h.

    {
        return m_xDeform->Evaluate(x, y, z, t);
    }

References m_xDeform, and Nektar::UnitTests::z().

◆ GetXDeformEquation()

LibUtilities::EquationSharedPtr Nektar::SpatialDomains::ZonePrescribe::GetXDeformEquation ( ) const

inline

Returns the equation for the prescribed motion in the x-coordinate.

Definition at line 315 of file Zones.h.

    {
        return m_xDeform;
    }

References m_xDeform.

◆ GetYDeform()

NekDouble Nektar::SpatialDomains::ZonePrescribe::GetYDeform	(	NekDouble	x,
		NekDouble	y,
		NekDouble	z,
		NekDouble	t
	)		const

inline

Returns point

Parameters

x

param y

Parameters

z	deformation in the y direction at time
t
x	x-coordinate
y	y-coordinate
z	z-coordinate
t	time

Returns: deformation in y direction

Definition at line 293 of file Zones.h.

    {
        return m_yDeform->Evaluate(x, y, z, t);
    }

References m_yDeform, and Nektar::UnitTests::z().

◆ GetYDeformEquation()

LibUtilities::EquationSharedPtr Nektar::SpatialDomains::ZonePrescribe::GetYDeformEquation ( ) const

inline

Returns the equation for the prescribed motion in the y-coordinate.

Definition at line 321 of file Zones.h.

    {
        return m_yDeform;
    }

References m_yDeform.

◆ GetZDeform()

NekDouble Nektar::SpatialDomains::ZonePrescribe::GetZDeform	(	NekDouble	x,
		NekDouble	y,
		NekDouble	z,
		NekDouble	t
	)		const

inline

Returns point

Parameters

x

param y

Parameters

z	deformation in the z direction at time
t
x	x-coordinate
y	y-coordinate
z	z-coordinate
t	time

Returns: deformation in z direction

Definition at line 308 of file Zones.h.

    {
        return m_zDeform->Evaluate(x, y, z, t);
    }

References m_zDeform, and Nektar::UnitTests::z().

◆ GetZDeformEquation()

LibUtilities::EquationSharedPtr Nektar::SpatialDomains::ZonePrescribe::GetZDeformEquation ( ) const

inline

Returns the equation for the prescribed motion in the z-coordinate.

Definition at line 327 of file Zones.h.

    {
        return m_zDeform;
    }

References m_zDeform.

◆ v_Move()

bool Nektar::SpatialDomains::ZonePrescribe::v_Move ( NekDouble time )

finalprotectedvirtual

Virtual function for movement of the zone at.

Parameters

time

Reimplemented from Nektar::SpatialDomains::ZoneBase.

Definition at line 284 of file Movement/Zones.cpp.

{
    int cnt = 0;
    for (auto &vert : m_verts)
    {
        auto pnt = m_origVerts[cnt++];
 
        Array<OneD, NekDouble> coords(3, 0.0);
        vert->GetCoords(coords);
 
        Array<OneD, NekDouble> newLoc(3, 0.0);
        newLoc[0] =
            m_xDeform->Evaluate(coords[0], coords[1], coords[2], time) + pnt(0);
        newLoc[1] =
            m_yDeform->Evaluate(coords[0], coords[1], coords[2], time) + pnt(1);
        newLoc[2] =
            m_zDeform->Evaluate(coords[0], coords[1], coords[2], time) + pnt(2);
 
        vert->UpdatePosition(newLoc[0], newLoc[1], newLoc[2]);
    }
 
    ClearBoundingBoxes();
 
    return true;
}

References Nektar::SpatialDomains::ZoneBase::ClearBoundingBoxes(), Nektar::SpatialDomains::ZoneBase::m_origVerts, Nektar::SpatialDomains::ZoneBase::m_verts, m_xDeform, m_yDeform, and m_zDeform.

Member Data Documentation

◆ m_xDeform

LibUtilities::EquationSharedPtr Nektar::SpatialDomains::ZonePrescribe::m_xDeform

protected

Equation specifying prescribed motion in x-direction.

Definition at line 334 of file Zones.h.

Referenced by GetXDeform(), GetXDeformEquation(), and v_Move().

◆ m_yDeform

LibUtilities::EquationSharedPtr Nektar::SpatialDomains::ZonePrescribe::m_yDeform

protected

Equation specifying prescribed motion in y-direction.

Definition at line 336 of file Zones.h.

Referenced by GetYDeform(), GetYDeformEquation(), and v_Move().

◆ m_zDeform

LibUtilities::EquationSharedPtr Nektar::SpatialDomains::ZonePrescribe::m_zDeform

protected

Equation specifying prescribed motion in z-direction.

Definition at line 338 of file Zones.h.

Referenced by GetZDeform(), GetZDeformEquation(), and v_Move().

Public Member Functions

Protected Member Functions

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

◆ ZonePrescribe()

◆ ~ZonePrescribe()

Member Function Documentation

◆ GetXDeform()

◆ GetXDeformEquation()

◆ GetYDeform()

◆ GetYDeformEquation()

◆ GetZDeform()

◆ GetZDeformEquation()

◆ v_Move()

Member Data Documentation

◆ m_xDeform

◆ m_yDeform

◆ m_zDeform