The gravitational potential term is a fourth order H1 scalar field that is used to represent the gravitational potential of the system. Its continuous trace supports the surface potential condition, and its spatial gradient supplies gravity in the primal formulation. More...

#include <fields.hpp>

Inheritance diagram for serif::discretization::blocks::gravity::potential:

[legend]

Collaboration diagram for serif::discretization::blocks::gravity::potential:

[legend]

Classes
struct	residual
	The residual block is a block that contains the residual of the gravitational potential term. It is a scalar field that is associated with the gravitational potential of the system. More...

struct	value
	The value block is a block that contains the value of the gravitational potential term. It is a scalar field that is associated with the gravitational potential of the system. More...

Public Types
using	FunctionalSpace = functional_space::DiscreteFunctionalSpace<functional_space::H1, 4, 0>
	fourth order H1 scalar field. Read the template parameters as follows: 1) H1 space, 2) fourth order, 3) rank 0 tensor field

using	Support = domain::AllDomains
	We support gravity on all domains, primarily since the only real boundary condition we have in the general case is that the potential goes to zero at infinity, which is in the vacuum domain.

using	Quantity = dimensions::GravitationalPotential
	This is a dimension of gravitational potential, which is a scalar field that is associated with the gravitational potential of the system.

Public Types inherited from serif::discretization::blocks::term< gravity >
using	field_type

Static Public Attributes
static constexpr std::string_view	name = meta::type_name<potential>()
	Compile time reflected name of the term.

static constexpr std::string_view	symbol = "φ"
	Compile time symbol used for the term. Note that this is a UTF-8 character and may not render correctly in all environments. (TODO: Should we introduce an ASCII fallback?, something like make this a tuple of form <main, fallback>?)

Detailed Description

The gravitational potential term is a fourth order H1 scalar field that is used to represent the gravitational potential of the system. Its continuous trace supports the surface potential condition, and its spatial gradient supplies gravity in the primal formulation.

Member Typedef Documentation

◆ FunctionalSpace

using serif::discretization::blocks::gravity::potential::FunctionalSpace = functional_space::DiscreteFunctionalSpace<functional_space::H1, 4, 0>

fourth order H1 scalar field. Read the template parameters as follows: 1) H1 space, 2) fourth order, 3) rank 0 tensor field

◆ Quantity

using serif::discretization::blocks::gravity::potential::Quantity = dimensions::GravitationalPotential

This is a dimension of gravitational potential, which is a scalar field that is associated with the gravitational potential of the system.

◆ Support

using serif::discretization::blocks::gravity::potential::Support = domain::AllDomains

We support gravity on all domains, primarily since the only real boundary condition we have in the general case is that the potential goes to zero at infinity, which is in the vacuum domain.

Member Data Documentation

◆ name

std::string_view serif::discretization::blocks::gravity::potential::name = meta::type_name<potential>()

staticconstexpr

Compile time reflected name of the term.

◆ symbol

std::string_view serif::discretization::blocks::gravity::potential::symbol = "φ"

staticconstexpr

Compile time symbol used for the term. Note that this is a UTF-8 character and may not render correctly in all environments. (TODO: Should we introduce an ASCII fallback?, something like make this a tuple of form <main, fallback>?)

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

src/include/serif/discretization/blocks/fields.hpp

Classes

Public Types

Static Public Attributes